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

Update Portal API spec #5399

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update Portal API spec #5399

wants to merge 1 commit into from

Conversation

edsonmichaque
Copy link

@edsonmichaque edsonmichaque commented Sep 12, 2024

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 labeled the PR

PR Type

documentation


Description

  • Updated the OpenAPI specification for the enterprise developer portal, enhancing the documentation for API endpoints.
  • Added new endpoints and adjusted existing ones to reflect the latest API changes.
  • Improved the documentation for API parameters and responses to provide clearer guidance for developers.

Changes walkthrough 📝

Relevant files
Documentation
enterprise-developer-portal-swagger.yaml
Update and enhance Portal API OpenAPI specification           

tyk-docs/assets/others/enterprise-developer-portal-swagger.yaml

  • Updated the OpenAPI specification for the portal API.
  • Added new endpoints and adjusted existing ones.
  • Improved documentation for API parameters and responses.
  • +2976/-1099
    Additional files (token-limit)
    enterprise-developer-portal-swagger.yaml
    ...                                                                                                           

    tyk-docs/assets/others/enterprise-developer-portal-swagger.yaml

    ...

    +2976/-1099

    💡 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

    github-actions bot commented Sep 12, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Sep 12, 2024

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

    Name Link
    🔨 Latest commit 80c3127
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66e2bf88ae578000087df1a3
    😎 Deploy Preview https://deploy-preview-5399--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.

    @edsonmichaque edsonmichaque marked this pull request as draft September 12, 2024 10:19
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Sep 12, 2024

    Thanks for submitting PR with updated Portal API spec @edsonmichaque

    There a large number of changes in the PR included, maybe as a result of linter etc.

    • The API spec does not render correctly in https://editor.swagger.io/
    • When the PR is ready for review can you indicate which new/updated endpoints are required for review

    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