You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ensure consistent API endpoint prefixes across documentation
Consider using a consistent prefix for API endpoints. The new endpoints use /api/apis/{apiID}/access, which introduces an additional /api prefix compared to the previous version. If this change is intentional and applies to all endpoints, ensure that it is consistently applied across all documentation and configurations to avoid confusion and potential integration issues.
-| `PUT` | `/api/apis/{apiID}/access` | Assign a list of owners to the specified API |-| `GET` | `/api/apis/{apiID}/access` | Retrieve the list of owners of the specified API |+| `PUT` | `/apis/{apiID}/access` | Assign a list of owners to the specified API |+| `GET` | `/apis/{apiID}/access` | Retrieve the list of owners of the specified API |
Suggestion importance[1-10]: 9
Why: The suggestion correctly identifies a potential inconsistency in the API endpoint prefixes, which could lead to confusion and integration issues. Ensuring consistency in documentation is crucial for clarity and usability.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
buger
deleted the
merge/release-5.3/b23063cf28bfb79ba5d4db5190452f1e77f43ae6
branch
User description
Update api-ownership.md add prefix api (#5090)
Update api-ownership.md
PR Type
documentation
Description
api-ownership.mddocumentation to include the/apiprefix in the endpoint paths for managing API owners.PUTandGETendpoints to reflect the new paths.Changes walkthrough 📝
api-ownership.md
Update API ownership endpoint paths with `/api` prefixtyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership.md
/apiprefix.PUTandGETendpoints for managing API owners.