Skip to content

Conversation

@buger
Copy link
Member

@buger buger commented Dec 3, 2025

Triggered by: imogenkraak

Included:

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

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

Note: Docs updates for Dashboard v5.11.0 (branch suffix: docs)

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

@github-actions
Copy link

github-actions bot commented Dec 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

Clarity

The new "Deprecated" note under allow_explicit_policy_id lacks context or formatting. Consider moving it into a proper admonition and explaining what replaces it or when it will be removed.

Set this value to `true` if you're planning to use Tyk Sync or Tyk Operator
Deprecated
Consistency

New summary "List APIs lined to a certificate" likely has a typo; "lined" should be "linked". Verify summaries and descriptions for similar typos.

summary: List APIs lined to a certificate
tags:
Backward Compat

Renaming schema XTykApiGateway to TykVendorExtension affects all refs. Validate no remaining references or external tooling relying on the old name; consider keeping an alias for compatibility.

content:
  application/json:
    examples:
      StreamsAPIExample:
        $ref: "#/components/examples/streamsExample"
    schema:
      allOf:
        - $ref: '#/components/schemas/OpenAPI3Schema'
        - $ref: '#/components/schemas/TykVendorExtension'
        - $ref: '#/components/schemas/XTykStreaming'

@github-actions
Copy link

github-actions bot commented Dec 3, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix sprintf placeholder mismatch

The format string has one placeholder but two arguments are provided, which can
cause a runtime error in Rego. Pass only the required argument or add another
placeholder. This prevents policy evaluation failures.

snippets/opa-rules.mdx [128-135]

-x := sprintf("You do not have permission to carry out '%v' operation.", [request_intent, input.request.path])
+x := sprintf("You do not have permission to carry out '%v' operation.", [request_intent])
Suggestion importance[1-10]: 8

__

Why: In the new hunk, sprintf has one %v placeholder but two arguments, which is a real runtime error in Rego. Fixing it prevents policy evaluation failures and directly improves correctness.

Medium
General
Restore boolean enum for compatibility

Removing the enum from BooleanQueryParam changes the schema contract and may break
clients relying on the explicit enum. If intentional, keep as-is; otherwise, restore
the enum to preserve backward compatibility.

swagger/dashboard-swagger.yml [11084-11086]

 BooleanQueryParam:
+  enum:
+  - true
+  - false
   example: true
   type: boolean
Suggestion importance[1-10]: 6

__

Why: The PR removes the boolean enum; restoring it can preserve schema contract for generators and clients. It's a reasonable compatibility suggestion, though not strictly required for OpenAPI correctness.

Low
Correct typo in endpoint summary

There's a typo in the summary ("lined" instead of "linked") which will surface in
generated docs and client SDKs. Correct the wording to maintain clarity and
professionalism.

swagger/dashboard-swagger.yml [5163]

-summary: List APIs lined to a certificate
+summary: List APIs linked to a certificate
Suggestion importance[1-10]: 5

__

Why: The typo “lined” appears in the new path summary and will surface in documentation and SDKs; correcting it improves quality, though the functional impact is minor.

Low

@sharadregoti sharadregoti changed the title [TT-16189] Update documentation for master [TT-16189] Dashboard Config & Swagger 5.11 Dec 4, 2025
sharadregoti
sharadregoti previously approved these changes Dec 8, 2025
@buger buger changed the title [TT-16189] Dashboard Config & Swagger 5.11 [TT-16189] Update documentation for master Dec 8, 2025
@buger buger force-pushed the update/TT-16189/release-main-docs branch from c5551cd to 0f33ce8 Compare December 8, 2025 14:50
@sharadregoti sharadregoti changed the title [TT-16189] Update documentation for master [TT-16189] Dashboard Config for master Dec 9, 2025
@sharadregoti sharadregoti changed the title [TT-16189] Dashboard Config for master [TT-16189] Dashboard Config for 5.11 Dec 9, 2025

Set this value to `true` if you planning to use Tyk Sync or Tyk Operator
Set this value to `true` if you're planning to use Tyk Sync or Tyk Operator
**DEPRECATED**. Use `redis_addrs` instead.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has nothing to do with redis_addrs

Copy link

@imogenkraak imogenkraak Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andyo-tyk I was asked to add this by Sharad, but have opened a PR addressing your comments in this PR: https://github.com/TykTechnologies/tyk-analytics/pull/5154

/api/apis/oas/{apiId}/urls:
get:
description: |
Get the Tyk generated server URLs for an OAS API. This endpoint returns structured URL information including decomposed components (protocol, domain, listen path, version path, query parameters, and headers) for all server URLs that Tyk generates for the API.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Get the Tyk generated server URLs for an OAS API. This endpoint returns structured URL information including decomposed components (protocol, domain, listen path, version path, query parameters, and headers) for all server URLs that Tyk generates for the API.
Get the Tyk generated server URLs for a Tyk OAS API. This endpoint returns structured URL information including decomposed components (protocol, domain, listen path, version path, query parameters, and headers) for all server URLs that Tyk generates for the API.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x-go-package: github.com/TykTechnologies/tyk/gateway
x-go-package: github.com/TykTechnologies/tyk/pkg/alias/gateway
OASServerURLsResponse:
description: Response containing Tyk-generated server URLs for an OAS API

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Response containing Tyk-generated server URLs for an OAS API
description: Response containing Tyk-generated server URLs for a Tyk OAS API

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

5 participants