Skip to content

Commit f8bc881

Browse files
committed
Merge branch 'contribution-guide' of https://github.com/TykTechnologies/tyk-docs into contribution-guide
2 parents 4475576 + ed39ce2 commit f8bc881

File tree

53 files changed

+2506
-1932
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2506
-1932
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
## Preview Link
1+
## Contributor checklist
22

3-
## Checklist
3+
- [ ] Reviewed *PR Code suggestions* and updated accordingly
4+
- [ ] **Tyklings:** Labled the PR with the relevant releases
5+
- [ ] **Tyklings:** Added Jira DX PR ticket to the subject
46

5-
- [ ] Added a **preview link**
6-
- [ ] Reviewed AI PR Agent suggestions
7-
- [ ] **For Tyk Members** - Added Jira DX PR ticket to the subject
8-
- [ ] **For Tyk Members** - Added the appropriate release labels (for fixes add the latest release)
7+
---
98

109
## New Contributors
11-
- [ ] Make sure you have started *your change* off *our latest `master`*.
12-
- [ ] I have [reviewed the guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING.md) for contributing to this repository.
13-
- [ ] I have [read the technical guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING-TECHNICAL-GUIDE.md) for contributing to this repository.
10+
- [ ] Start the PR branch from our latest `master`
11+
- [ ] I have read the [repository contribution guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING.md)
12+
- [ ] I have read the [repository technical guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING-TECHNICAL-GUIDE.md)
13+
14+
---

.github/workflows/page_available_since.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
workflow_dispatch:
44
jobs:
55
check-page-availability:
6-
runs-on: ubuntu-20.04
6+
runs-on: ubuntu-latest
77
name: Check version a page is available
88
steps:
99

.probe/writer.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1-
You are senior technical writer.
2-
Before jumping on the task you first, in details analyse user request, and try to provide elegant and concise solution.
3-
If solution is clear, you can jump to implementation right away, if not, you can ask user a clarification question, by calling attempt_completion tool, with required details.
1+
You are helpful senior technical writer.
2+
Your role is to automatically assist with GitHub issues.
3+
4+
Before jumping on the task or replying, you first should analyze the user request or issue details thoroughly.
5+
6+
When responding:
7+
1. Be concise but thorough in your responses.
8+
2. If the issue description is unclear, ask clarifying questions.
9+
3. Request any additional information you might need to better assist
10+
4. Provide helpful information related to the query
11+
5. Try to provide an elegant and concise solution.
12+
6. If there are multiple different solutions or next steps, convey it in the response
13+
7. If solution is clear, you can jump to implementation right away, if not, you can ask user a clarification question, by calling attempt_completion tool, with required details.
14+
15+
When writing content:
16+
Don’t use title case. Following sentence case conventions, like in Google and GitHub style guides.

tyk-docs/assets/others/enterprise-developer-portal-swagger.yaml

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
openapi: 3.1.0
22
info:
3-
title: Tyk Enterprise Developer Portal Management API
3+
title: Tyk Developer Portal
44
description: >-
5+
6+
<img src="https://tyk.io/docs/img/developer_portal_swagger_image.png" width="963" height="250">
7+
58
## <a name="introduction"></a> Introduction
69
710
The Tyk Enterprise Developer Portal Management API offers programmatic
@@ -15,7 +18,7 @@ info:
1518
1619
This API requires an admin authorisation token that is available for admin
1720
users of the portal in the profile page.
18-
version: v1.13.0
21+
version: 1.14.0
1922
servers:
2023
- url: http://localhost:3001/portal-api
2124
tags:
@@ -63,6 +66,8 @@ tags:
6366
description: Posts management
6467
- name: SSO Profiles
6568
description: SSO Profiles management
69+
- name: Tags
70+
description: "Tags management: link API Products to blog posts and control their display."
6671
paths:
6772
/access_requests:
6873
get:
@@ -4177,6 +4182,7 @@ paths:
41774182
/webhooks:
41784183
get:
41794184
summary: List all webhooks
4185+
description: Retrieves all configured webhooks.
41804186
operationId: list-webhooks
41814187
tags:
41824188
- Webhooks
@@ -4189,6 +4195,7 @@ paths:
41894195
$ref: "#/components/schemas/Webhook-index"
41904196
post:
41914197
summary: Create a new webhook
4198+
description: Creates a new webhook configuration.
41924199
operationId: create-webhook
41934200
tags:
41944201
- Webhooks
@@ -4215,6 +4222,7 @@ paths:
42154222
/webhooks/{webhook_id}:
42164223
get:
42174224
summary: Get a webhook by ID
4225+
description: Retrieves a webhook using its unique identifier.
42184226
operationId: get-webhook
42194227
tags:
42204228
- Webhooks
@@ -4239,6 +4247,7 @@ paths:
42394247
description: Bad request
42404248
put:
42414249
summary: Update a webhook by ID
4250+
description: Updates an existing webhook's configuration using its unique identifier.
42424251
operationId: update-webhook
42434252
tags:
42444253
- Webhooks
@@ -4270,6 +4279,7 @@ paths:
42704279
description: Bad request
42714280
delete:
42724281
summary: Delete a webhook by ID
4282+
description: Removes a webhook using its unique identifier.
42734283
operationId: delete-webhook
42744284
tags:
42754285
- Webhooks
@@ -4295,6 +4305,7 @@ paths:
42954305
/webhooks/{webhook_id}/headers:
42964306
get:
42974307
summary: List all headers for a webhook
4308+
description: Retrieves all headers for a specific webhook.
42984309
operationId: list-webhook-headers
42994310
tags:
43004311
- Webhooks
@@ -4319,6 +4330,7 @@ paths:
43194330
description: Bad request
43204331
post:
43214332
summary: Add a new header to a webhook
4333+
description: Adds a new header to an existing webhook.
43224334
operationId: create-webhook-header
43234335
tags:
43244336
- Webhooks
@@ -4351,6 +4363,9 @@ paths:
43514363
/webhooks/{webhook_id}/headers/{header_id}:
43524364
get:
43534365
summary: Get a header by ID for a specific webhook
4366+
description: >-
4367+
Retrieves the details of a specific header associated with a given webhook.
4368+
Useful for inspecting custom headers configured for webhook delivery.
43544369
operationId: get-webhook-header
43554370
tags:
43564371
- Webhooks
@@ -4380,6 +4395,7 @@ paths:
43804395
description: Bad request
43814396
put:
43824397
summary: Update a header by ID for a specific webhook
4398+
description: Updates an existing header in a webhook.
43834399
operationId: update-webhook-header
43844400
tags:
43854401
- Webhooks
@@ -4422,6 +4438,7 @@ paths:
44224438
description: Validation error
44234439
delete:
44244440
summary: Delete a header by ID for a specific webhook
4441+
description: Removes a header from a webhook.
44254442
operationId: delete-webhook-header
44264443
tags:
44274444
- Webhooks
@@ -5870,6 +5887,18 @@ components:
58705887
type: integer
58715888
description: UID of a user to whom this application will belong
58725889
example: 1
5890+
Visibility:
5891+
type: string
5892+
description: >-
5893+
Controls who can access this application. Options are:
5894+
`personal` (visible only to you), `team` (shared with your team),
5895+
and `organisation` (accessible to all members of your organisation).
5896+
enum:
5897+
- personal
5898+
- team
5899+
- organisation
5900+
example: personal
5901+
default: organisation
58735902
type: object
58745903
Client-ID-attributes:
58755904
properties:

tyk-docs/content/ai-management/mcps/api-to-mcp.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ graph LR
2525
D["AI Assistant"] <--> C
2626
C <--> E["Your API"]
2727
28-
style A fill:#d3e5ef,stroke:#333,stroke-width:2px,font-size:18px
29-
style B fill:#d5f5e3,stroke:#333,stroke-width:2px,font-size:18px
30-
style C fill:#d5f5e3,stroke:#333,stroke-width:2px,font-size:18px
31-
style D fill:#eeeeee,stroke:#333,stroke-width:2px,font-size:18px
32-
style E fill:#fdebd0,stroke:#333,stroke-width:2px,font-size:18px
28+
style A fill:#ffffff,stroke:#D1D1E0,stroke-width:1px,font-size:18px
29+
style B fill:#d5f5e3,stroke:#D1D1E0,stroke-width:1px,font-size:18px
30+
style C fill:#d5f5e3,stroke:#D1D1E0,stroke-width:1px,font-size:18px
31+
style D fill:#eeeeee,stroke:#D1D1E0,stroke-width:1px,font-size:18px
32+
style E fill:#ffffff,stroke:#D1D1E0,stroke-width:1px,font-size:18px
3333
34-
linkStyle default stroke-width:3px
34+
linkStyle default stroke-width:2px
3535
```
3636

3737
## Key Features
@@ -44,7 +44,7 @@ graph LR
4444
- **MCP Extensions:** Support for custom x-mcp extensions to override tool names and descriptions
4545
- **Multiple Integration Options:** Works with Claude Desktop, Cursor, Vercel AI SDK, and other MCP-compatible environments
4646

47-
Check the [complete technical list](https://github.com/TykTechnologies/api-to-mcp#features) is available in our GitHub repository.
47+
Check the [complete features list](https://github.com/TykTechnologies/api-to-mcp#features) is available in Tyk's *api-to-mcp* GitHub repository.
4848

4949
## Quick Start {#quick-start}
5050

@@ -134,9 +134,11 @@ flowchart LR
134134
class A,B input;
135135
class C,D,E,F tool;
136136
class G,H,I runtime;
137+
138+
linkStyle default stroke-width:2px
137139
```
138140

139-
### Request lifecycle: how an AI assistant invokes an API tool
141+
### Request lifecycle: how an AI assistant invokes an API tool
140142

141143
The following diagram illustrates the flow of a request through the system at runtime:
142144

@@ -167,6 +169,7 @@ sequenceDiagram
167169
Tool->>MCP: Map to MCP Error
168170
MCP-->>AI: Tool Execution Error
169171
end
172+
170173
```
171174

172175
API to MCP can be found in [api-to-mcp GitHub repository](https://github.com/TykTechnologies/api-to-mcp)

tyk-docs/content/configure/outbound-email-configuration.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ algolia:
1212
importance: 0
1313
---
1414

15-
{{< warning success >}}
16-
17-
**Attention:**
18-
19-
You’ve reached a page related to the *Tyk Classic Portal*. If you were searching for *API documentation of the new Tyk
20-
Developer Portal* please use the latest
21-
[Postman collection]({{< ref "/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api" >}}) page.
22-
</br>
23-
</br>
24-
**Future deprecation of Tyk Classic Portal**
25-
26-
This product is no longer actively developed as it
27-
has been superseded by the new [Tyk Developer Portal]({{< ref "portal/overview/intro" >}}).
28-
</br>
29-
Please note that the Tyk Classic Portal now has limited support and maintenance. Please contact us at
30-
[[email protected]](<mailto:[email protected]?subject=Tyk classic developer portal>)if you have any questions.
31-
32-
{{< /warning >}}
15+
{{< include "legacy-classic-portal-api" >}}
3316

3417
### Custom Email Templates
3518

tyk-docs/content/developer-support/release-notes/dashboard.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,66 @@ Our minor releases are supported until our next minor comes out.
3838

3939
## 5.8 Release Notes
4040

41+
### 5.8.2 Release Notes
42+
43+
#### Release Date 1st July 2025
44+
45+
#### Release Highlights
46+
47+
This is a version bump to align with Gateway v5.8.2, no changes have been implemented in this release.
48+
49+
#### Breaking Changes
50+
51+
There are no breaking changes in this release.
52+
53+
#### Dependencies {#dependencies-5.8.2}
54+
55+
##### Compatibility Matrix For Tyk Components
56+
57+
| Dashboard Version | Recommended Releases | Backwards Compatibility |
58+
|---- |---- |---- |
59+
| 5.8.2 | MDCB v2.8.1 | MDCB v2.8.1 |
60+
| | Operator v1.2.0 | Operator v0.17 |
61+
| | Sync v2.1.0 | Sync v2.1.0 |
62+
| | Helm Chart v3.0 | Helm all versions |
63+
| | EDP v1.13 | EDP all versions |
64+
| | Pump v1.12.0| Pump all versions |
65+
| | TIB (if using standalone) v1.7.0 | TIB all versions |
66+
67+
##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.8.2}
68+
69+
| Third Party Dependency | Tested Versions | Compatible Versions | Comments |
70+
| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- |
71+
| [GoLang](https://go.dev/dl/) | 1.23 | 1.23 | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.23 |
72+
| [Redis](https://redis.io/download/) | 6.2.x, 7.x | 6.2.x, 7.x | Used by Tyk Dashboard |
73+
| [MongoDB](https://www.mongodb.com/try/download/community) | 5.0.x, 6.0.x, 7.0.x | 5.0.x, 6.0.x, 7.0.x | Used by Tyk Dashboard |
74+
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x | Used by Tyk Dashboard |
75+
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS]({{< ref "api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference" >}})|
76+
77+
#### Deprecations
78+
79+
There are no deprecations in this release.
80+
81+
#### Upgrade instructions {#upgrade-5.8.2}
82+
83+
If you are upgrading to 5.8.2, please follow the detailed [upgrade instructions](#upgrading-tyk).
84+
85+
#### Downloads
86+
87+
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.2)
88+
- ```bash
89+
docker pull tykio/tyk-dashboard:v5.8.2
90+
```
91+
- Helm charts
92+
- [tyk-charts v3.0.0]({{< ref "developer-support/release-notes/helm-chart#300-release-notes" >}})
93+
94+
#### Changelog {#Changelog-v5.8.2}
95+
96+
No changes in this release.
97+
98+
99+
---
100+
41101
### 5.8.1 Release Notes
42102

43103
#### Release Date 9 May 2025

0 commit comments

Comments
 (0)