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 consistency in API endpoint path formatting by removing the /api/ prefix
It's recommended to ensure consistency in the API endpoint path formatting. The added endpoints use a prefix /api/ which is not consistent with the existing API documentation style. Consider removing the /api/ prefix to maintain uniformity across the documentation.
-| `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 addresses a maintainability issue by ensuring consistency in the API endpoint path formatting, which is important for clear and uniform documentation. The existing code indeed shows a discrepancy in the endpoint paths.
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.
DX-1523
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master
.PR Type
Documentation
Description
api-ownership.md
file to include the/api
prefix for better clarity and consistency.PUT
andGET
endpoint paths for assigning and retrieving API owners.Changes walkthrough 📝
api-ownership.md
Update API ownership endpoint paths with `/api` prefix
tyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership.md
/api
prefix.PUT
andGET
endpoint paths for assigning and retrieving APIowners.