Skip to content

Commit ed84e56

Browse files
bugermativm02
andauthored
Merging to release-5.8: [TT-14490] Update documentation for master - Dashboard 5.8.1 (#6336)
[TT-14490] Update documentation for master - Dashboard 5.8.1 (#6336) Import config/docs Co-authored-by: mativm02 <83959431+mativm02@users.noreply.github.com>
1 parent 0f1454e commit ed84e56

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ info:
55
name: Tyk Technologies
66
url: https://tyk.io/contact
77
description: |-
8+
<img src="https://tyk.io/docs/img/dashboard_admin_swagger_image.png" width="963" height="250">
9+
810
For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.
911
1012
In order to use the Dashboard Admin API, you'll need to get the `admin_secret` value from your Tyk Dashboard configurations.

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

+9-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ info:
55
name: Tyk Technologies
66
url: https://tyk.io/contact
77
description: |2
8-
8+
<img src="https://tyk.io/docs/img/swagger_dashboard_image.png" width="963" height="250">
9+
910
## <a name="introduction"></a> Introduction
1011
1112
The Tyk Dashboard API offers granular, programmatic access to a centralised database of resources that your Tyk nodes can pull from. This API has a dynamic user administrative structure which means the secret key that is used to communicate with your Tyk nodes can be kept secret and access to the wider management functions can be handled on a user-by-user and organisation-by-organisation basis.
@@ -43,7 +44,7 @@ servers:
4344
- url: https://{tenant}
4445
variables:
4546
tenant:
46-
default: localhost:8080
47+
default: localhost:3000
4748
description: Your dashboard host
4849
security:
4950
- bearerAuth: []
@@ -13343,11 +13344,13 @@ components:
1334313344
$ref: '#/components/schemas/ServiceDiscovery'
1334413345
type: object
1334513346
TimeDuration:
13346-
format: int64
13347-
type: integer
13347+
format: duration
13348+
type: string
13349+
example: "30s"
1334813350
TimeReadableDuration:
13349-
format: int64
13350-
type: integer
13351+
format: duration
13352+
type: string
13353+
example: PT2H30M15S
1335113354
TrackEndpoint:
1335213355
nullable: true
1335313356
properties:

0 commit comments

Comments
 (0)