[DX-1679] Update the Tyk Site with Reference #5362
Conversation
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -244,7 +244,7 @@ password: foo | |||
| ### channel | |||
|
|
|||
| The channel to publish messages to. | |||
| This field supports [interpolation functions]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation.mdinterpolation#bloblang-queries" >}}). | |||
| This field supports [interpolation functions]({{< ref "product-stack/tyk-streaming/configuration/common-configuration/interpolation.md#interpolation#bloblang-queries" >}}). | |||
There was a problem hiding this comment.
Created a separate PR for it #5388. Thanks!!!
| @@ -57,7 +57,7 @@ In this example the endpoint caching middleware has been configured to cache all | |||
| For ultimate control over what Tyk caches, you should use the advanced configuration options for the per-endpoint cache. You can separately configure, for each HTTP method for an endpoint: | |||
| - an individual cache refresh (timeout) | |||
| - a list of HTTP response codes that should be cached | |||
| - a pattern match to cache only requests containing specific data in the [request body]({{< ref " basic-config-and-security/reduce-latency/caching/advanced-cache#selective-caching-by-body-value" >}}) | |||
| - a pattern match to cache only requests containing specific data in the [request body]({{< ref "basic-config-and-security/reduce-latency/caching/advanced-cache#selective-caching-by-body-value" >}}) | |||
There was a problem hiding this comment.
Created a separate PR for it #5388. Thanks!!!
|
|
||
| For programmatic control, configure OAuth 2.0 directly within your API's JSON definition: | ||
|
|
||
| ```json |
There was a problem hiding this comment.
| ```json | |
| ```yaml |
There was a problem hiding this comment.
yaml gives you code highlighting while it doesn't show an error
1. Removing unused fields from the front matter section. 2. Put back the orig date 3. Added tags
fixed aliases and description
|
Is the AuthN&AuthZ still WIP? not sure about it.
|
There was a problem hiding this comment.
Thanks for submitting PR. Not sure if PR ready for full review yet, but have done an initial review.
For the Authentication & Authorization section have added some thoughts suggestions. Not sure if could divide the content into subpages under an Authentication & Authorization menu folder in API Management section or maybe use a horizontal rule between sections on the single page?
For the Authentication & Authorisation page have reviewed structure with some suggestions and maybe could refactor high level structure as shown below to group into sections:
|- Secure Your APIs
|- Methods or Types as section heading?
|——-OAuth 2.0
|————Include Revoke OAuth Tokens here as sub item here
|——-Basic Authentication
|——-Bearer Tokens
|——-External OAuth Middleware
|——-HMAC Signatures
|——-JSON Web Tokens (JWT)
|——-OpenID Connect (OIDC)
|—-—Mutual TLS (mTLS)
|——-Open (keyless)
|- Custom Authentication Using Plugins
|——-Go Plugins
|——-Python CoProcess and JSVM Plugins
|- Combine Authentication Methods
|- Set Physical Tyk Key Expiry and Deletion
|
|
||
| ### Understanding the OAuth 2.0 Flow within Tyk | ||
|
|
||
| * **Client ID Registration:** Begin by registering a unique Client ID within Tyk for each resource owner. |
There was a problem hiding this comment.
Should this section moved to the beginning of Setup your OAuth 2.0 Authorization as an overview and could a diagram accompany explanation to illustrate the flow?
|
|
||
| ### Configure Notifications | ||
|
|
||
| To receive notifications about token changes (e.g., new tokens, refresh tokens) configure the `notifications` section in your API definition: |
There was a problem hiding this comment.
Add an example of notifications section in API Definition
|
|
||
| ```json | ||
| { | ||
| "auth_code": "", |
There was a problem hiding this comment.
Update example to show notification change has occurred
There was a problem hiding this comment.
I don't understand this comment
There was a problem hiding this comment.
The fields in the JSON example are empty, they do not show that a change has occurred and the notification_type field is empty
|
|
||
| ## Set Up OAuth 2.0 Authorization | ||
|
|
||
| Tyk offers comprehensive support for OAuth 2.0, providing two main approaches to integrate this authorization framework: |
There was a problem hiding this comment.
Maybe start this section with an overview given in section (Understanding the OAuth 2.0 Flow within Tyk) and then group options 1 and 2 under a parent header Integrating OAuth 2.0 With Tyk or something similar?
|
|
||
| For programmatic control, configure OAuth 2.0 directly within your API's JSON definition: | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Maybe add a summary explaining what the example configuration shows
| 2. Go to the Advanced Options panel. | ||
| 3. Find the Upstream Certificates section and attach the appropriate certificate. | ||
|
|
||
| {{< img src="/img/2.10/client_mtls_multiple_auth.png" alt="Static mTLS Configuration" >}} |
There was a problem hiding this comment.
Current image displayed is related to Static mTLS, should it be the image included here?
| 3. Find the Upstream Certificates section and attach the appropriate certificate. | ||
|
|
||
| {{< img src="/img/2.10/client_mtls_multiple_auth.png" alt="Static mTLS Configuration" >}} | ||
|
|
There was a problem hiding this comment.
Should the equivalent action for how to achieve in Tyk Operator also be shown here?
https://tyk.io/docs/basic-config-and-security/security/mutual-tls/upstream-mtls/#via-tyk-operator
| title: Using Tyk Dashboard | ||
| --- | ||
|
|
||
| The Tyk Dashboard is your central hub for managing APIs, monitoring performance, and configuring security settings. This guide will walk you through the key features available on the Tyk Dashboard. |
There was a problem hiding this comment.
Remember to add accompanying images
| - /basic-config-and-security/security/authentication-&-authorization/ | ||
| --- | ||
|
|
||
| # Authentication and Authorization in Tyk |
There was a problem hiding this comment.
Maybe remove this section title since it duplicates the page title
dcs3spp
changed the title
| --- | ||
|
|
||
|
|
||
| Overview |
|
|
||
| {{< img src="/img/2.10/keys_menu.png" alt="Keys Menu" >}} | ||
|
|
||
| 2. **Click "CREATE"** to generate a new key. |
There was a problem hiding this comment.
Image says "add key", not create
| - Self-Managed | ||
| - Tyk Cloud | ||
| - API Gateway | ||
| title: Create Tyk Account |
There was a problem hiding this comment.
Title seems a little blunt - perhaps it could be something like "How to Create a Tyk Account"
There was a problem hiding this comment.
compare with https://tyk.io/docs/deployment-and-operations/tyk-cloud-platform/quick-start/ - not sure we need both pages
|
|
||
| ### Step 2: Choose "Start Your 48-hour Free Trial" | ||
|
|
||
| On the sign-up page, select the "Start your 48-hour free trial" option to begin your Tyk Cloud experience. |
There was a problem hiding this comment.
This line says "48-hour" trial, but line 27 says "14-day" trial. Are these for different things? It's a bit confusing.
|
|
||
| ### Step 6: Access the Developer Portal | ||
|
|
||
| Once your account is set up, you can access the Tyk Developer Portal. This portal allows you to manage your APIs, view analytics, and customize your API consumer experience. |
There was a problem hiding this comment.
Consider changing "API consumer experience" to "the experience for your API consumers" for better readability.
| - **Metadata**: Add metadata such as user IDs, which can be used by middleware components. | ||
|
|
||
| 5. **Click "CREATE"**: | ||
| - Once the key is created, a **Key successfully generated** pop-up will be displayed showing your key. **Copy the key** to your clipboard and save it for future reference as it will not be shown again. |
There was a problem hiding this comment.
Seems to switch between imperative voice ("Create an API Key") and passive voice ("A pop-up will be displayed"). Could be made all imperative "After creating the key, a success pop-up appears showing your key."
There was a problem hiding this comment.
Now that all this information is combined onto one page, it's important that folks are sent to the correct part of the page from search results. I assume this would happen, but thought I'd flag it, just in case.
|
|
||
| ### Personalize the Portal | ||
|
|
||
| Go to "Portal Management" to customize the appearance and functionality of your developer portal. Manage API documentation and catalogues to enhance developer experience. |
There was a problem hiding this comment.
I think we're defaulting to EN-US now, right? So "catalogues" should be "catalogs"
There was a problem hiding this comment.
we'll need updated screenshots
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master.