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

[DX-1523]Update api-ownership.md add prefix api #5090

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Jul 16, 2024

DX-1523

User description

For internal users - Please add a Jira DX PR ticket to the subject!



Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labelled the PR

PR Type

Documentation


Description

  • Updated the endpoint paths in the api-ownership.md file to include the /api prefix for better clarity and consistency.
  • Modified the PUT and GET endpoint paths for assigning and retrieving API owners.

Changes walkthrough 📝

Relevant files
Documentation
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

  • Updated endpoint paths to include /api prefix.
  • Modified PUT and GET endpoint paths for assigning and retrieving API
    owners.
  • +2/-2     

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

    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
    Maintainability
    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.

    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 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.

    9

    Copy link

    netlify bot commented Jul 16, 2024

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

    Name Link
    🔨 Latest commit 05b9905
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669623f5eb02f300085a8b45
    😎 Deploy Preview https://deploy-preview-5090--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.

    @yurisasuke yurisasuke merged commit b23063c into master Jul 16, 2024
    10 checks passed
    @yurisasuke yurisasuke deleted the Keithwachira-patch-update-ownwership branch July 16, 2024 07:43
    @yurisasuke
    Copy link
    Member Author

    /release to release-5.4

    Copy link

    tykbot bot commented Jul 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 16, 2024
    Update api-ownership.md
    
    (cherry picked from commit b23063c)
    Copy link

    tykbot bot commented Jul 16, 2024

    @Keithwachira Succesfully merged PR

    buger added a commit that referenced this pull request Jul 16, 2024
    Update api-ownership.md add prefix api (#5090)
    
    Update api-ownership.md
    @yurisasuke yurisasuke changed the title Update api-ownership.md add prefix api [DX-1523]Update api-ownership.md add prefix api Jul 16, 2024
    @yurisasuke
    Copy link
    Member Author

    /release to release-5.3

    Copy link

    tykbot bot commented Jul 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jul 16, 2024
    Update api-ownership.md
    
    (cherry picked from commit b23063c)
    Copy link

    tykbot bot commented Jul 16, 2024

    @Keithwachira Succesfully merged PR

    buger added a commit that referenced this pull request Jul 16, 2024
    Update api-ownership.md add prefix api (#5090)
    
    Update api-ownership.md
    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.

    1 participant