Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merging to release-5.4: Update api-ownership.md add prefix api (#5090) #5092

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 16, 2024

User description

Update api-ownership.md add prefix api (#5090)

Update api-ownership.md


PR Type

documentation


Description

  • Updated the api-ownership.md documentation to include the /api prefix in the endpoint paths.
  • Modified the PUT and GET endpoint paths for managing API ownership.

Changes walkthrough 📝

Relevant files
Documentation
api-ownership.md
Update endpoint paths in `api-ownership.md` documentation

tyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership.md

  • Updated endpoint paths to include the /api prefix.
  • Modified PUT and GET endpoint paths for API ownership management.
  • +2/-2     

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

    Update api-ownership.md
    
    (cherry picked from commit b23063c)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Correct the API endpoint paths to ensure consistency across the documentation

    It's recommended to use a consistent format for API endpoint paths across the
    documentation. The newly added paths start with /api/apis/, which might be a typo or
    inconsistency if the base path for APIs is typically /apis/. If /api/apis/ is not a
    standard or newly introduced base path, consider correcting this to maintain
    uniformity.

    tyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership.md [93-94]

    -| `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 potential inconsistency in the API endpoint paths, which is crucial for maintaining uniformity and preventing confusion in the documentation. The correction aligns the new paths with the existing format.

    9

    Copy link

    netlify bot commented Jul 16, 2024

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

    Name Link
    🔨 Latest commit 2590736
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669624d40e9a0900086cb0d6
    😎 Deploy Preview https://deploy-preview-5092--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

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

    @buger buger merged commit 2652755 into release-5.4 Jul 16, 2024
    10 checks passed
    @buger buger deleted the merge/release-5.4/b23063cf28bfb79ba5d4db5190452f1e77f43ae6 branch July 16, 2024 07:46
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants