Skip to content

Commit 7d3710d

Browse files
committed
Merge branch 'caroltyk-tyk-operator' of https://github.com/TykTechnologies/tyk-docs into caroltyk-tyk-operator
2 parents ded4ba9 + 85ce068 commit 7d3710d

File tree

89 files changed

+213
-212
lines changed

Some content is hidden

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

89 files changed

+213
-212
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
<!-- Go over all the following points, and put an `x` in all the boxes that apply -->
2626

2727
- [ ] I have added a **preview link** to the PR description.
28+
- [ ] I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
2829
- [ ] I have [reviewed the guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING.md) for contributing to this repository.
2930
- [ ] I have [read the technical guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING-TECHNICAL-GUIDE.md) for contributing to this repository.
3031
- [ ] Make sure you have started *your change* off *our latest `master`*.

tyk-docs/content/advanced-configuration/transform-traffic.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
Title: Request and response middleware
33
tags: ["middleware", "API request", "API response", "request processing", "response processing"]
4-
description: "An overview of Tyk's customisable request and response processing chain"
4+
description: "An overview of Tyk's customizable request and response processing chain"
55
aliases:
66
- /transform-traffic/endpoint-designer/
77
---
@@ -10,7 +10,7 @@ When you configure an API on Tyk, the Gateway will proxy all requests received a
1010

1111
Within that chain are a highly configurable set of optional middleware that can, on a per-endpint basis:
1212
- apply processing to [API requests](#middleware-applied-to-the-api-request) before they are proxied to the upstream service
13-
- apply customisation to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client
13+
- apply customization to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client
1414

1515
Tyk also supports a powerful custom plugin feature that enables you to add custom processing at different stages in the processing chains. For more details on custom plugins please see the [dedicated guide]({{< ref "plugins" >}}).
1616

tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ There are related [Request Header Transform]({{< ref "transform-traffic/request-
1919

2020
## When to use response header transformation
2121

22-
#### Customising responses for specific clients
22+
#### Customizing responses for specific clients
2323

2424
A frequent use case for response header transformation is when a client requires specific headers for their application to function correctly. For example, a client may require a specific header to indicate the status of a request or to provide additional information about the response.
2525

tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Using middleware with Tyk OAS APIs"
77

88
### Introduction
99

10-
Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customise the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.
10+
Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customize the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.
1111

1212
{{< note success >}}
1313
**Note**

tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ aliases:
1313

1414
## Set up an Event Webhook with an API Definition
1515

16-
In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customised) to be delivered to any open endpoint.
16+
In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customized) to be delivered to any open endpoint.
1717

1818
The webhook handler allows the configuration of the method, body, header values, and target URL and makes use of Go templates to expose the event metadata.
1919

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,16 @@ If `SMTPUsername` or `SMTPPassword` is omitted, Tyk assumes that authentication
101101
"SecretAccessKey": "KEY"
102102
},
103103
```
104-
### Customise your Welcome Emails
104+
### Customize your Welcome Emails
105105

106-
You can customise the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.
106+
You can customize the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.
107107

108108
{{< youtube XNyKRAlTDVs >}}
109109

110110

111111
1. Select **Settings** from your **Dashboard** > **Portal Management**
112112
2. You can change the from email address and the from email name for your welcome emails.
113-
3. To use customised email content, select **Enable custom welcome email**.
113+
3. To use customized email content, select **Enable custom welcome email**.
114114
4. You can then add the following custom content:
115115
* Email Subject
116116
* Email Body content
@@ -123,14 +123,14 @@ You can customise the welcome email that a developer recieves when they signup t
123123
6. Click **Save** at the top of the Portal Settings screen.
124124

125125

126-
### Customise your Key Approval Emails
126+
### Customize your Key Approval Emails
127127

128128
#### Editing the Email Body
129129

130130
1. Select **Settings** from your **Dashboard** > **Portal Management**
131131
2. From the "API Key approval email" section, select "Enable custom approval email", and edit the API Key email body.
132132

133-
{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customisation" >}}
133+
{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customization" >}}
134134

135135
#### Add an image or logo to the Key Approval Email
136136

@@ -145,7 +145,7 @@ You can customise the welcome email that a developer recieves when they signup t
145145
The `LINK TO IMAGE` must be a publicly hosted resource.
146146
{{< /note >}}
147147

148-
In an Self-Managed installation you have full access to the HTML template, allowing you further customisation.
148+
In an Self-Managed installation you have full access to the HTML template, allowing you further customization.
149149

150150
#### Portal Manager Email Settings
151151

tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ weight: 0
99

1010
Use case: What if your developer portal is not exactly what I need?
1111

12-
Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customise the portal's branding per organisation?
12+
Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customize the portal's branding per organisation?
1313

1414
We have the ability to configure the portal to suit your needs. For details, including a video tutorial, see [Create a Custom Developer Portal]({{< ref "tyk-developer-portal/tyk-portal-classic/customise/custom-developer-portal" >}}).

tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ The Multi-Cloud Redis container is ephemeral, it isn't configured for persistenc
1313

1414
If using Redis with Multi-Cloud we strongly recommend using an external Redis database.
1515

16-
There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customise the configuration, but again, we don't recommend it.
16+
There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customize the configuration, but again, we don't recommend it.
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
date: 2017-03-23T13:02:38Z
3-
title: Portal API Catalogue
3+
title: Portal API Catalog
44
menu:
55
main:
66
parent: "Key Concepts"
@@ -9,14 +9,14 @@ aliases:
99
- /concepts/api-catalogue/
1010
---
1111

12-
The API Catalogue is part of the API Developer Portal of the Dashboard. It is the central place for you to manage which APIs your registered developers have access to.
12+
The API Catalog is part of the API Developer Portal of the Dashboard. It is the central place for you to manage which APIs your registered developers have access to.
1313

14-
The API catalogue is completely separate from the regular API list section of the dashboard, as you may only wish to expose some of those APIs managed by Tyk to end users.
14+
The API catalog is completely separate from the regular API list section of the dashboard, as you may only wish to expose some of those APIs managed by Tyk to end users.
1515

16-
API Catalogue entries are not actual directly tied to APIs in any way, they are connected to policies.
16+
API Catalog entries are not actual directly tied to APIs in any way, they are connected to policies.
1717

1818
The reason for this is that policies can give access to a bundle of underlying APIs and therefore can represent a facade of services exposed as a single interface.
1919

20-
The concept of the API Catalogue is that you publish what you wish your external APIs to appear as. So, for example, if you have a widgets API that is composed of 4 microservices (i.e. `/comments`, `/pricing`, `/details`, and `/SKU`), which are managed as four separate APIs in your Dashboard, but combined under a single Security Policy (so one token can access all four APIs), then you may not wish to have your users know these are microservices, they are just endpoints in your widgets API.
20+
The concept of the API Catalog is that you publish what you wish your external APIs to appear as. So, for example, if you have a widgets API that is composed of 4 microservices (i.e. `/comments`, `/pricing`, `/details`, and `/SKU`), which are managed as four separate APIs in your Dashboard, but combined under a single Security Policy (so one token can access all four APIs), then you may not wish to have your users know these are microservices, they are just endpoints in your widgets API.
2121

2222
This approach allows you to separate "management" from "consumption" using a simple CMS-based bundling approach.

tyk-docs/content/getting-started/tutorials/publish-api.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is for the closed source [Tyk Developer Portal]({{< ref "tyk-developer-port
2525
{{< tab_end >}}
2626
{{< tab_start "Self-Managed" >}}
2727

28-
## Add an API and Swagger based Docs to your Portal Catalogue
28+
## Add an API and Swagger based Docs to your Portal Catalog
2929

3030
Managing your portal is a key part of Tyk Dashboard, this tutorial helps you get started working with your portal and publishing your APIs to your developers.
3131

@@ -65,15 +65,15 @@ Save the policy by clicking **Create**.
6565

6666
The API that you defined earlier is active and will work as you've seen in the previous tutorial, this time we want to use the Portal to generate a token for a named developer.
6767

68-
Not all APIs are visible to the Portal, only the ones you tell it about, so from the **Catalogue** menu, select **Add API** then:
68+
Not all APIs are visible to the Portal, only the ones you tell it about, so from the **Catalog** menu, select **Add API** then:
6969

7070
1. Select your **Default** policy
7171
2. Fill in the description fields
7272
3. Ensure the **Enable this API** is selected
7373

74-
Save the API Catalogue entry by clicking **Update**.
74+
Save the API Catalog entry by clicking **Update**.
7575

76-
{{< img src="/img/2.10/portal_confirmation_on_prem.png" alt="Catalogue Entry" >}}
76+
{{< img src="/img/2.10/portal_confirmation_on_prem.png" alt="Catalog Entry" >}}
7777

7878
### Step 6: Set your Portal hostname
7979

tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In any system, a task or operation takes a certain period of time to complete. W
99

1010
Tyk's Enforced Timeout middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. If the timeout expires, then Tyk will notify the client with an `HTTP 504 Gateway Timeout` error.
1111

12-
This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customised and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.
12+
This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customized and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.
1313

1414
## When to use an enforced timeout
1515

tyk-docs/content/plugins/supported-languages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The JavaScript Virtual Machine provides pluggable middleware that can modify a r
7878
* **TCP Access**: The JSVM has no socket access so working with DB drivers and directly with Redis is not possible.
7979

8080
### Rich Plugins
81-
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customised architecture to be built that integrates with a user's infrastructure.
81+
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customized architecture to be built that integrates with a user's infrastructure.
8282

8383
Rich Plugins bring about the following improvements:
8484

tyk-docs/content/plugins/supported-languages/javascript-middleware.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ JavaScript functions are available globally in the same namespace. So, if you in
4141

4242
The JavaScript Virtual Machine (JSVM) provided in the Gateway is a traditional ECMAScript5 compatible environment.
4343

44-
Before you can use JavaScript customisation in any component you will need to enable the JSVM.
44+
Before you can use JavaScript customization in any component you will need to enable the JSVM.
4545

4646
You do this by setting `enable_jsvm` to `true` in your `tyk.conf` [file]({{< ref "tyk-oss-gateway/configuration#enable_jsvm" >}}).
4747

tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ aliases:
1515
- /plugins/javascript-middleware/middleware-scripting-guide
1616
---
1717

18-
Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customisation and optimization of your request handling.
18+
Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customization and optimization of your request handling.
1919

2020
In this guide we will cover the features and resources available to you when creating custom functions, highlighting where there are limitations for the different middleware stages.
2121

tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Create Custom Authentication Plugin With Python"
55

66
In the realm of API security, HMAC-signed authentication serves as a foundational concept. In this developer-focused blog post, we'll use HMAC-signed authentication as the basis for learning how to write gRPC custom authentication plugins with Tyk Gateway. Why learn how to write Custom Authentication Plugins?
77

8-
- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customisation capabilities.
8+
- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customization capabilities.
99
- **Practical experience**: Gain hands-on experience in implementing custom authentication logic tailored to specific use cases, starting with HMAC-signed authentication.
1010
- **Enhanced control**: Exercise greater control over authentication flows and response handling, empowering developers to implement advanced authentication mechanisms beyond built-in features.
1111

@@ -655,7 +655,7 @@ While Tyk Gateway already supports HMAC-signed authentication out of the box, th
655655
656656
It's important to note that the authentication mechanism implemented in this guide solely verifies the HMAC signature's validity and does not include access control checks against specific API resources. Developers should enhance this implementation by integrating access control logic to ensure authenticated requests have appropriate access permissions.
657657
658-
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customise API authentication solutions according to their unique requirements.
658+
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customize API authentication solutions according to their unique requirements.
659659
660660
---
661661

tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ To generate the Protocol Buffers bindings we use the Gradle build task:
120120
gradle build
121121
```
122122

123-
If you need to customise any setting related to the bindings generation step, check the `build.gradle` file.
123+
If you need to customize any setting related to the bindings generation step, check the `build.gradle` file.
124124

125125
### Implement Server
126126

tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This document serves as a developer's guide for understanding the key concepts a
1616

1717
This comprehensive guide covers essential tasks, including:
1818

19-
1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customisation and tailored processing at each stage of the request lifecycle.
19+
1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customization and tailored processing at each stage of the request lifecycle.
2020

2121
2. **Configuring Tyk Gateway:** Set up Tyk Gateway to communicate with your gRPC Server and, optionally, an external secured web server hosting the gRPC plugin bundle for API configurations. Configure Tyk Gateway to fetch the bundle configured for an API from the web server, enabling seamless integration with gRPC plugins. Specify connection settings for streamlined integration.
2222

23-
3. **API Configuration:** Customise API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.
23+
3. **API Configuration:** Customize API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.
2424

2525
4. **API Testing:** Test that Tyk Gateway integrates with your gRPC server for the plugins configured for your API.
2626

0 commit comments

Comments
 (0)