[TT-12823, DX-1604] Update documentation for 5.3

[buger]

User description

Triggered by: lghiur

Included:

Tyk Gateway: true
Tyk Dashboard: true
Tyk MDCB false
Tyk Pump false

Intended for: 5.3
Changes sourced from: release-5.3.3
Config info generator branch: main

Note: Docs updates for 5.3.3 (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-12823

---

PR Type

Documentation

---

Description

This PR updates the documentation for Tyk version 5.3.3 with the following changes:

• Updated the Tyk Dashboard API documentation to version 5.3.3, including new asset management endpoints.
• Corrected spelling in the gateway configuration documentation.
• Enhanced and clarified the gateway configuration documentation by adding missing descriptions, reorganizing sections, and correcting field descriptions.

---

Changes walkthrough 📝

Relevant files

Documentation

dashboard-swagger.yml Update API documentation to version 5.3.3 and add asset management tyk-docs/assets/others/dashboard-swagger.yml Updated API version from 5.3.0 to 5.3.3. Added new Assets tag and associated endpoints. Added descriptions and tags for asset management endpoints. +13/-1    gateway-config.md Correct spelling in gateway configuration documentation    tyk-docs/content/shared/gateway-config.md Corrected spelling from "favor" to "favour". +1/-1      x-tyk-gateway.md Enhance and clarify gateway configuration documentation    tyk-docs/content/shared/x-tyk-gateway.md Added missing descriptions for several fields. Reorganized and added new sections for OAuth and JWT validation. Corrected field descriptions for clarity and consistency. +162/-142

---

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

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Security	Implement authorization checks for new 'Assets' endpoints to enhance security For the new 'Assets' endpoints, ensure that proper authorization checks are implemented to prevent unauthorized access to asset management functions. tyk-docs/assets/others/dashboard-swagger.yml [63-64] - name: Assets description: Assets management +security: + - ApiKeyAuth: [] Suggestion importance[1-10]: 9 Why: Ensuring that proper authorization checks are in place for the new 'Assets' endpoints is crucial for security. This suggestion addresses a significant security concern and should be implemented.	9
Enhancement	Define response models for the 'Assets' endpoints to improve API documentation clarity Add response models for the new 'Assets' endpoints to provide a clear structure for the response data, improving API documentation and client code generation. tyk-docs/assets/others/dashboard-swagger.yml [63-64] - name: Assets description: Assets management +responses: + '200': + description: Successfully retrieved the asset list + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/asset' Suggestion importance[1-10]: 8 Why: Adding response models for the 'Assets' endpoints enhances API documentation and aids client code generation, improving overall API usability and clarity.	8
	Add a new endpoint for bulk updating assets to enhance the API's functionality Add a new endpoint under the 'Assets' tag to ensure comprehensive API coverage for asset management, such as updating multiple assets simultaneously. tyk-docs/assets/others/dashboard-swagger.yml [63-64] - name: Assets description: Assets management +/api/assets/bulk_update: + post: + tags: + - Assets + summary: Update multiple assets + description: Allows updating multiple assets simultaneously. + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/asset' + responses: + '200': + description: Successfully updated assets + content: + application/json: + schema: + type: object + properties: + status: + type: string + data: + type: array + items: + $ref: '#/components/schemas/asset' Suggestion importance[1-10]: 7 Why: Adding a bulk update endpoint for assets is a valuable enhancement that improves the API's functionality. However, it is not critical and should be considered as a future improvement rather than an immediate necessity.	7

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	9ff8a14
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66b9ff8c3903ee00084542b0
😎 Deploy Preview	https://deploy-preview-5188--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	772e44f
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66bc788c853019000812b57e
😎 Deploy Preview	https://deploy-preview-5188--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[dcs3spp]

Thanks for raising PR @lghiur I have reviewed with minor suggestions/observations. Could a peer review be arranged to check expected content is included and the content removals are valid?