You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new query param description for certificate listing ('filter') changes default/behavior wording. Verify that 'omit' is indeed the default and works only with 'mode=detailed', and that this doesn’t contradict existing behavior or clients relying on previous description.
- description: |- Defines the filtering strategy applied to certificate keys. This query param works only in combination with detailed mode (mode=detailed). `omit` (default) – Returns all certificates regardless of private key association. with_pk – Returns only certificates that include a private key. without_pk – Returns only certificates that do not include a private key.name: filterexample: omitrequired: false
The example for organisation notifications includes future dates and a long cert_id string; validate these reflect real formats/lengths and timezone formatting used by the API, and confirm 'refresh' query param type should be boolean (currently documented as string).
/api/org/notifications:
get:
description: Retrieve all notifications for an organisation.operationId: getAllOrganisationNotificationsparameters:
- description: Setting refresh to true will force the API to refresh the list of notifications.example: 'true'in: queryname: refreshrequired: falseschema:
type: stringresponses:
"200":
content:
application/json:
example:
- id: b52f491a-2946-408b-9330-2736db85705bcreated_at: 2025-08-13T11:16:12.194968+02:00org_id: 683d6e6a954737af2aa8e5c2hash: '17090217262863020087'kind: warningtopic: certificate.expirytitle: Certificate will expire soonmessage: Certificate with ID 683d6e6a954737af2aa8e5c20d545f3211d5a53684114dc8b3ebb2503edf6fabf2e5812425be2fa108f3fb4d will expire in less than 18 daysdata:
cert_id: 683d6e6a954737af2aa8e5c20d545f3211d5a53684114dc8b3ebb2503edf6fabf2e5812425be2fa108f3fb4dexpiry_date: 2025-08-31T08:41:53Zdays_remaining: 17schema:
type: arrayitems:
$ref: '#/components/schemas/OrganisationNotification'description: Returns a list of notifications for an organisation."401":
content:
application/json:
example:
Message: Not authorisedMeta: nullStatus: Errordescription: Unauthorized"403":
content:
application/json:
example:
Message: 'access denied: You do not have permission to access /api/org/notifications'Meta: nullStatus: Errordescription: Forbiddensummary: Retrieve notificationstags:
- Organisation Notifications
The updated TIB host URL line lost code formatting backticks around the URL pattern; ensure consistency with surrounding docs and whether https is allowed/required.
ENV: <b>TYK_DB_TIB_HOST_CONNECTIONSTRING</b><br />
Type: `string`<br />
The URL to the host. It must be in the form: http://domain:port.
Set this value only if you need to use external Tyk Identity Broker
### identity_broker.host.secret
ENV: <b>TYK_DB_TIB_HOST_SECRET</b><br />
The refresh query should be a boolean to avoid ambiguity and ensure correct client generation. Update the schema type and example to boolean, and clarify accepted values in the description.
/api/org/notifications:
get:
description: Retrieve all notifications for an organisation.
operationId: getAllOrganisationNotifications
parameters:
- - description: Setting refresh to true will force the API to refresh the list of notifications.- example: 'true'+ - description: Set to true to force a refresh of the notifications list.+ example: true
in: query
name: refresh
required: false
schema:
- type: string+ type: boolean
Suggestion importance[1-10]: 8
__
Why: Changing refresh from string to boolean reduces ambiguity and improves OpenAPI client correctness; the existing snippet precisely matches the new /api/org/notifications parameter block.
Medium
General
Constrain filter values via enum
Avoid backticks and long unstructured prose in OpenAPI descriptions as some generators render Markdown inconsistently. Also, provide the allowed values via an enum to ensure clients validate input correctly.
-- description: |- +- description: |-
Defines the filtering strategy applied to certificate keys.
- This query param works only in combination with detailed mode (mode=detailed). - `omit` (default) – Returns all certificates regardless of private key association.- with_pk – Returns only certificates that include a private key.- without_pk – Returns only certificates that do not include a private key.+ This query param works only with detailed mode (mode=detailed).+ Values:+ - omit (default): Returns all certificates regardless of private key association.+ - with_pk: Returns only certificates that include a private key.+ - without_pk: Returns only certificates that do not include a private key.
name: filter
example: omit
required: false
+ schema:+ type: string+ enum: [omit, with_pk, without_pk]
Suggestion importance[1-10]: 7
__
Why: Mapping the filter query to an explicit enum in its schema improves validation and client generation; the snippet matches the new hunk context around lines 4746–4755 and the improved code aligns with the described change.
Medium
Specify formats and required fields
Add explicit formats for date-time fields and required properties to improve validation and client generation. At minimum, mark created_at as format: date-time and require core identifiers and message fields.
Why: Adding format: date-time and required increases schema robustness and client usability; while accurate and beneficial, it's a non-critical validation enhancement matching the new OrganisationNotification schema block.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
lghiur
changed the title
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.10.0
Config info generator branch: main
Note: Dashboard - Docs updates for 5.10.0 (branch suffix: docs)
JIRA: https://tyktech.atlassian.net/browse/TT-15720
PR Type
Documentation
Description
Update Dashboard API version to 5.10.0
Add organisation notifications API and schemas
Improve certificate listing and streams schema docs
Add config for certificate expiry monitoring
Diagram Walkthrough
File Walkthrough
dashboard-swagger.yml
Swagger: 5.10.0, org notifications API, schema updatestyk-docs/assets/others/dashboard-swagger.yml
/api/org/notificationswith responses.OrganisationNotification,CertificateExpiryData.cert filters; enhance Streams OAS description.
dashboard-config.md
Config docs: certificate expiry monitor and clarificationstyk-docs/content/shared/dashboard-config.md
notifications.certificate_expiry_monitorsettings.