tyk-docs icon indicating copy to clipboard operation
tyk-docs copied to clipboard

[DX-1657] Plugin API Config Overview

Open dcs3spp opened this issue 5 months ago • 4 comments

User description

For internal users - Please add a Jira DX PR ticket to the subject!

DX-1657


Preview Link

preview

Description

Following previous review, have raised PR with suggested improvements

Screenshots (if appropriate)


Checklist

  • [x] I have added a preview link to the PR description.
  • [x] I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • [x] I have reviewed the guidelines for contributing to this repository.
  • [x] I have read the technical guidelines for contributing to this repository.
  • [x] Make sure you have started your change off our latest master.
  • [x] I labeled the PR

PR Type

documentation


Description

  • Enhanced the documentation for plugin API configuration by adding detailed descriptions of plugin data and its availability for different plugin types.
  • Introduced a table summarizing the availability of data for each plugin type, improving clarity for users.
  • Updated the documentation to include links to language-specific plugin guides for Golang, gRPC, Javascript, and Python.
  • Clarified the process of how Tyk runs local plugins, detailing the necessary configuration information required for each hook.

Changes walkthrough 📝

Relevant files
Documentation
overview.md
Enhance plugin API configuration documentation with detailed data and
execution process

tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/overview.md

  • Added detailed descriptions of plugin data and its availability for
    different plugin types.
  • Introduced a table summarizing data availability for each plugin type.
  • Updated sections to include links to language-specific plugin
    documentation.
  • Clarified the process of how Tyk runs local plugins with necessary
    configuration details.
  • +43/-13 

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    dcs3spp avatar Sep 12 '24 14:09 dcs3spp