Skip to content

[TT-14839] 5.8.3 Dashboard Update documentation #6630

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

[TT-14839] 5.8.3 Dashboard Update documentation #6630

wants to merge 18 commits into from

Conversation

buger
Copy link
Member

@buger buger commented Jul 3, 2025 •
edited by github-actions bot
Loading

User description

Triggered by: lghiur

Included:

Tyk Gateway: false
Tyk Dashboard: true
Tyk MDCB false
Tyk Pump false

Intended for: master
Changes sourced from: release-5.8.3
Config info generator branch: main

Note: Dashboard updates for 5.8.3 release (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-14839

PR Type

Documentation, Enhancement

Description

  • Updated Dashboard API documentation to version 5.8.3.

  • Added new endpoints for API definition schemas retrieval.

  • Enhanced certificate listing with filtering options.

  • Expanded schema response objects for new endpoints.

Changes diagram

flowchart LR
  A["Dashboard API docs v5.8.0"] -- "Update version" --> B["Dashboard API docs v5.8.3"]
  B -- "Add endpoints" --> C["/api/schemas/apidefs"]
  B -- "Add endpoints" --> D["/api/schemas/apidefs/oas"]
  B -- "Add endpoints" --> E["/api/schemas/apidefs/streams-oas"]
  B -- "Enhance" --> F["Certificate listing filter param"]
  B -- "Expand" --> G["Schema response objects"]
Loading

Changes walkthrough 📝

Relevant files
Documentation
dashboard-swagger.yml
Update API docs version, add schema endpoints, enhance filtering

tyk-docs/assets/others/dashboard-swagger.yml

  • Updated API version from 5.8.0 to 5.8.3.
  • Added new endpoints for API definition schemas, OAS, and Streams OAS.
  • Introduced filtering for certificate listing by private key
    association.
  • Expanded schema definitions for new API responses.
    		• +203/-4 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Jul 3, 2025

    ⚠️ Deploy preview for PR #6630 did not become live after 3 attempts.
    Please check Netlify or try manually: Preview URL

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Jul 3, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Accuracy

    The new and updated API endpoints and schema response objects should be validated for accuracy and completeness, ensuring that descriptions, parameter types, and response examples match the actual implementation.

     
                  Message: Could not retrieve OAS schema. Schema not found for version.
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Internal server error.
    summary: Get OAS schema.
    tags:
    - Schemas
/api/schemas/apidefs:
  get:
    description: Get all API definition schemas.
    operationId: getAllApidefsSchema
    parameters:
      - description: The OAS version.
        example: 3.0.3
        in: query
        name: oasVersion
        required: false
        schema:
          type: string
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllApidefSchemasResponse'
        description: All API definition schemas response.
      "401":
        content:
          application/json:
            example:
              Message: Not authorised
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Unauthorized
      "403":
        content:
          application/json:
            example:
              Message: 'access denied: You do not have permission to access  /api/schemas/apidefs'
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Forbidden
      "500":
        content:
          application/json:
            example:
              Message: Could not retrieve schema. schema not found for version.
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Internal server error.
    summary: Get all API definition schemas.
    tags:
      - Schemas
/api/schemas/apidefs/oas:
  get:
    description: Get API definition OAS schema.
    operationId: getApidefOASSchema
    parameters:
      - description: The OAS version.
        example: 3.0.3
        in: query
        name: oasVersion
        required: false
        schema:
          type: string
      - description: Pretty print the result.
        example: 'true'
        in: query
        name: pretty
        required: false
        schema:
          type: string
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OASSchemaResponse'
        description: OAS schema response.
      "401":
        content:
          application/json:
            example:
              Message: Not authorised
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Unauthorized
      "403":
        content:
          application/json:
            example:
              Message: 'access denied: You do not have permission to access  /api/schemas/apidefs/oas'
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Forbidden
      "500":
        content:
          application/json:
            example:
              Message: Could not retrieve schema. schema not found for version.
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Internal server error.
    summary: Get API definition OAS schema.
    tags:
      - Schemas
/api/schemas/apidefs/streams-oas:
  get:
    description: Retrieve schema for Tyk Streams APIs, enabling developers and integrators to validate or generate stream-based API definitions programmatically. Supports optional OAS version selection and pretty-print formatting via query parameters.
    operationId: getApidefStreamsOASSchema
    parameters:
      - description: The OAS version.
        example: 3.0.3
        in: query
        name: oasVersion
        required: false
        schema:
          type: string
      - description: Pretty print the result.
        example: 'true'
        in: query
        name: pretty
        required: false
        schema:
          type: string
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OASSchemaResponse'
        description: OAS schema response.
      "401":
        content:
          application/json:
            example:
              Message: Not authorised
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Unauthorized
      "403":
        content:
          application/json:
            example:
              Message: 'access denied: You do not have permission to access  /api/schemas/apidefs/streams-oas'
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Forbidden
      "500":
        content:
          application/json:
            example:
              Message: Could not retrieve schema. schema not found for version.
              Meta: null
              Status: Error
            schema:
              $ref: '#/components/schemas/ApiResponse'
        description: Internal server error.
    summary: Get API definition Streams OAS schema.
    tags:
      - Schemas
    Consistency in Tag Usage

    The introduction of the new "Schemas" tag and changes from "Schema" to "Schemas" should be checked for consistency across all relevant endpoints and documentation references.

     
    - description: Get schemas.
  name: Schemas
- description: |

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Jul 3, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @lghiur lghiur changed the title [TT-14839] Update documentation for master [TT-14839] 5.8.3 Dashboard Update documentation Jul 3, 2025
    @netlify Netlify
    Copy link

    netlify bot commented Jul 3, 2025 •
    edited
    Loading

    ✅ PS. Add to the end of url /docs/nightly

    Name Link
    🔨 Latest commit 7901c38
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6875468e36e5b60008e9086a
    😎 Deploy Preview https://deploy-preview-6630--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 project configuration.

    @lghiur lghiur added the 5.8.3 label Jul 3, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @yurisasuke yurisasuke yurisasuke approved these changes

    @sharadregoti sharadregoti sharadregoti approved these changes

    @andyo-tyk andyo-tyk andyo-tyk approved these changes

    Assignees
    No one assigned
    Labels
    5.8.3 Review effort 2/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    5 participants
    @buger @yurisasuke @sharadregoti @andyo-tyk @lghiur