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

[DX-1409] Fix virtual endpoints Javascript request object documentation

Open dcs3spp opened this issue 6 months ago • 9 comments

User description

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

DX-1409


Preview Link

preview

Description

Document virtual endpoint request object properties.

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

  • Added detailed documentation for the request object properties specific to virtual endpoint functions.
  • Included a note highlighting the limited set of properties available in the request object for virtual endpoints.
  • Provided a JSON example to illustrate the structure of the Params property.

Changes walkthrough 📝

Relevant files
Documentation
middleware-scripting-guide.md
Document virtual endpoint functions' request object properties

tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md

  • Added documentation for virtual endpoint functions' request object
    properties.
  • Included a note specifying the properties available in the request
    object for virtual endpoint functions.
  • Provided an example of the Params property structure in JSON format.
  • +23/-0   

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

    dcs3spp avatar Jul 30 '24 10:07 dcs3spp