Merging to release-5.5: DX-1672 Add path-based permission example for Operator (#5375)

buger commented 1 month ago

User description

DX-1672 Add path-based permission example for Operator (#5375)

Update secure-an-api.md

Co-authored-by: Komal Sukhani komaldsukhani@gmail.com

PR Type

documentation

Description

Added a new example for path-based permissions in the Tyk Operator documentation.
Introduced the allowed_urls field to specify path and method restrictions in the API configuration.
Updated the documentation to include explanations for the new path-based permission feature.

Changes walkthrough 📝

Relevant files

Documentation

secure-an-api.md

Add path-based permission example and documentation

tyk-docs/content/tyk-stack/tyk-operator/secure-an-api.md

Added an example of path-based permissions in the API specification.

Introduced allowed_urls to restrict access per path and method.

Updated documentation to explain path-based permissions.

+8/-0

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

github-actions[bot] commented 1 month ago

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

github-actions[bot] commented 1 month ago

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add a description to the `allowed_urls` field to clarify the behavior with multiple methods or URLs ___ Ensure that the `allowed_urls` field includes a description of the expected behavior when multiple methods or URLs are specified. This will help users understand how to configure complex permissions. [tyk-docs/content/tyk-stack/tyk-operator/secure-an-api.md [120-123]](https://github.com/TykTechnologies/tyk-docs/pull/5394/files#diff-62583238874aadf2fcc63ad539d89257c7bd38c3b7d35bf52a30015156f26dd4R120-R123) ```diff -allowed_urls: # Path-based permissions +allowed_urls: # Path-based permissions. Specify multiple methods or URLs to configure complex permissions. - url: /get methods: - GET ``` Suggestion importance[1-10]: 7 Why: The suggestion improves documentation clarity by explaining the behavior of `allowed_urls` when multiple methods or URLs are specified, which aids users in configuring complex permissions. However, it is not critical to functionality, hence a moderate score.	7

netlify[bot] commented 1 month ago

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

Name	Link
Latest commit	46a681fcb8a75da4ae792e76262888446d16843f
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66e071bdb96ccc0008401faf
Deploy Preview	https://deploy-preview-5394--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[bot] commented 1 month ago

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

Name	Link
Latest commit	46a681fcb8a75da4ae792e76262888446d16843f
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66e071bdb96ccc0008401faf
Deploy Preview	https://deploy-preview-5394--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.

TykTechnologies / tyk-docs