Skip to content

Commit d6023f1

Browse files
sharadregotisharadregoti
authored
Fixed Swagger Docs (#863)
1 parent c38eeea commit d6023f1

File tree

7 files changed

+113
-7
lines changed

7 files changed

+113
-7
lines changed

‎ai-management/ai-studio/ai-studio-swagger.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Tyk AI Studio API"
33
description: "Tyk AI Studio API"
44
keywords: "OpenAPI Spec for AI Studio, Tyk AI Studio OAS, Tyk AI Portal REST"
5-
sidebarTitle: "API Documentation"
5+
sidebarTitle: "Overview"
66
---
77

8+
This is the API for the AI Studio user and group management system.

‎dashboard-admin-api.mdx‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
---
22
title: "Tyk Dashboard Admin API"
3+
description: "Tyk Dashboard Admin API documentation. This page provides details on how to use the Tyk Dashboard Admin API for setting up and provisioning a Tyk Dashboard instance."
34
order: 4
4-
sidebarTitle: "Dashboard Admin"
5+
sidebarTitle: "Overview"
56
---
67

8+
<img src="https://tyk.io/docs/img/dashboard_admin_swagger_image.png" width="963" height="250"/>
9+
10+
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.
11+
12+
In order to use the Dashboard Admin API, you'll need to get the `admin_secret` value from your Tyk Dashboard configurations.
13+
14+
The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:
15+
16+
```
17+
admin-auth: <your-secret>
18+
```
19+

‎docs.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,18 +393,30 @@
393393
"tyk-apis",
394394
{
395395
"group": "Gateway",
396+
"pages": [
397+
"tyk-gateway-api"
398+
],
396399
"openapi": "swagger/gateway-swagger.yml"
397400
},
398401
{
399402
"group": "Dashboard",
403+
"pages": [
404+
"tyk-dashboard-api"
405+
],
400406
"openapi": "swagger/dashboard-swagger.yml"
401407
},
402408
{
403409
"group": "Dashboard Admin",
410+
"pages": [
411+
"dashboard-admin-api"
412+
],
404413
"openapi": "swagger/dashboard-admin-swagger.yml"
405414
},
406415
{
407416
"group": "MDCB",
417+
"pages": [
418+
"tyk-mdcb-api"
419+
],
408420
"openapi": "swagger/mdcb-swagger.yml"
409421
},
410422
"tyk-identity-broker/tib-rest-api"
@@ -539,6 +551,9 @@
539551
"product-stack/tyk-enterprise-developer-portal/deploy/configuration",
540552
{
541553
"group": "Developer Portal API",
554+
"pages": [
555+
"product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api"
556+
],
542557
"openapi": "swagger/enterprise-developer-portal-swagger.yaml"
543558
},
544559
"product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-api-list-of-endpoints",
@@ -690,6 +705,9 @@
690705
"ai-management/ai-studio/notifications",
691706
{
692707
"group": "API Documentation",
708+
"pages": [
709+
"ai-management/ai-studio/ai-studio-swagger"
710+
],
693711
"openapi": "swagger/ai-studio-swagger.yml"
694712
}
695713
]

‎product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api.mdx‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
---
2-
title: "Tyk Enterprise Developer Portal API"
2+
title: "Tyk Developer Portal API"
3+
description: "Tyk Developer Portal API documentation. This page provides details on how to use the Tyk Developer Portal Management API for managing portal resources."
34
order: 3
4-
sidebarTitle: "Developer Portal API"
5+
sidebarTitle: "Overview"
56
---
67

8+
<img src="https://tyk.io/docs/img/developer_portal_swagger_image.png" width="963" height="250"/>
9+
10+
## <a name="introduction"></a> Introduction
11+
12+
The Tyk Developer Portal Management API offers programmatic
13+
access to all portal resources that your instance of the portal manages.
14+
This API repeats functionality of the user interface and enables APIs
15+
consumers integrating their portal instances with their other IT systems
16+
such as billings, CRMs, ITSM systems and other software.
17+
18+
19+
## Authentication
20+
21+
This API requires an admin authorisation token that is available for admin
22+
users of the portal in the profile page.

‎tyk-dashboard-api.mdx‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,36 @@
11
---
22
title: "Tyk Dashboard API"
3+
description: "Tyk Dashboard API documentation. This page provides details on how to use the Tyk Dashboard API for managing organisations, users, API definitions, and more."
34
order: 3
4-
sidebarTitle: "Dashboard"
5+
sidebarTitle: "Overview"
56
---
67

8+
<img src="https://tyk.io/docs/img/swagger_dashboard_image.png" width="963" height="250"/>
9+
10+
## <a name="introduction"></a> Introduction
11+
12+
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.
13+
14+
A common question around using a database-backed configuration is how to programmatically add API definitions to your Tyk nodes, the Dashboard API allows much more fine-grained, secure and multi-user access to your Tyk cluster, and should be used to manage a database-backed Tyk node.
15+
16+
The Tyk Dashboard API works seamlessly with the Tyk Dashboard (and the two come bundled together).
17+
18+
## <a name="security-hierarchy"></a> Security Hierarchy
19+
20+
The Dashboard API provides a more structured security layer to managing Tyk nodes.
21+
22+
### Organisations, APIs and Users
23+
24+
With the Dashboard API and a database-backed Tyk setup, (and to an extent with file-based API setups - if diligence is used in naming and creating definitions), the following security model is applied to the management of Upstream APIs:
25+
26+
* **Organisations**: All APIs are *owned* by an organisation, this is designated by the 'OrgID' parameter in the API Definition.
27+
* **Users**: All users created in the Dashboard belong to an organisation (unless an exception is made for super-administrative access).
28+
* **APIs**: All APIs belong to an Organisation and only Users that belong to that organisation can see the analytics for those APIs and manage their configurations.
29+
* **API Keys**: API Keys are designated by organisation, this means an API key that has full access rights will not be allowed to access the APIs of another organisation on the same system, but can have full access to all APIs within the organisation.
30+
* **Access Rights**: Access rights are stored with the key, this enables a key to give access to multiple APIs, this is defined by the session object in the core Tyk API.
31+
32+
In order to use the Dashboard API, you'll need to get the 'Tyk Dashboard API Access Credentials' secret from your user profile on the Dashboard UI.
33+
34+
The secret you set should then be sent along as a header with each Dashboard API Request in order for it to be successful:
35+
36+
`authorization: <your-secret>`

‎tyk-gateway-api.mdx‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
11
---
22
title: "Tyk Gateway API"
3+
description: "Tyk Gateway API documentation. This page provides details on how to use the Tyk Gateway API for managing session objects, policies, API definitions, and more."
34
keywords: "OpenAPI Spec, OpenAPI Specification, OAS, REST, Tyk Gateway OpenAPI Spec, Tyk Gateway OAS, API Gateway OAS, API Gateway REST"
45
order: 3
5-
sidebarTitle: "Gateway"
6+
sidebarTitle: "Overview"
67
---
78

9+
<img src="https://tyk.io/docs/img/swagger_gateway_image.png" width="963" height="250"/>
10+
<img src="https://tyk.io/docs/img/swagger_gateway_direction_image.png" width="946" height="392"/>
11+
12+
The Tyk Gateway API is the primary means for integrating your application with the Tyk API Gateway system. This API is very small, and has no granular permissions system. It is intended to be used purely for internal automation and integration.
13+
14+
**Warning: Under no circumstances should outside parties be granted access to this API.**
15+
16+
The Tyk Gateway API is capable of:
17+
18+
* Managing session objects (key generation).
19+
* Managing and listing policies.
20+
* Managing and listing API Definitions (only when not using the Tyk Dashboard).
21+
* Hot reloads / reloading a cluster configuration.
22+
* OAuth client creation (only when not using the Tyk Dashboard).
23+
24+
In order to use the Gateway API, you'll need to set the **secret** parameter in your tyk.conf file.
25+
26+
The shared secret you set should then be sent along as a header with each Gateway API Request in order for it to be successful:
27+
28+
`x-tyk-authorization: <your-secret>`
29+
<br/>
30+
31+
<b>The Tyk Gateway API is subsumed by the Tyk Dashboard API in Pro installations.</b>

‎tyk-mdcb-api.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Tyk MDCB API"
3+
description: "Tyk MDCB API documentation. This page provides details on how to use the Tyk Multi Data Center Bridge (MDCB) API for monitoring connected Data Planes and accessing diagnostic data."
34
keywords: "OpenAPI Spec, OpenAPI Specification, OAS, REST, Tyk MDCB OpenAPI Spec, Tyk MDCB OAS, MDCB API REST"
45
order: 3
5-
sidebarTitle: "Multi Data Center Bridge"
6+
sidebarTitle: "Overview"
67
---
78

9+
This API provides operations for monitoring Data Planes connected to MDCB and accessing diagnostic data.
10+
It includes endpoints for retrieving connected data plane details, performing health checks,
11+
and accessing Go's built-in pprof diagnostics for advanced performance profiling.

0 commit comments

Comments
 (0)