Merging to release-5.8.0: TT-14170 adjusted godoc for gw config (#6938) #6945
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### **User description** <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-14170" title="TT-14170" target="_blank">TT-14170</a></summary> <br /> <table> <tr> <th>Summary</th> <td>Update docs for Gateway changes</td> </tr> <tr> <th>Type</th> <td> <img alt="Story" src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10315?size=medium" /> Story </td> </tr> <tr> <th>Status</th> <td>In Code Review</td> </tr> <tr> <th>Points</th> <td>N/A</td> </tr> <tr> <th>Labels</th> <td>-</td> </tr> </table> </details> <!-- do not remove this marker as it will break jira-lint's functionality. added_by_jira_lint --> --- Updated GW config godocs ___ ### **PR Type** - Documentation ___ ### **Description** - Updated access log documentation for Gateway. - Revised TLS version and SSL ciphers documentation links. - Modified control API port comment and link. - Updated KV store and secrets documentation references. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table> <tr> <td> <details> <summary><strong>config.go</strong><dd><code>Update godoc comments for Gateway configuration.</code> </dd></summary> <hr> config/config.go <li>Updated AccessLogsConfig comments to clarify log generation.<br> <li> Revised TLS version and custom SSL ciphers links in <br>HttpServerOptionsConfig.<br> <li> Modified ControlAPIPort comment for updated self-managed doc link.<br> <li> Updated KV store and secrets documentation links. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6938/files#diff-fe44f09c4d5977b5f5eaea29170b6a0748819c9d02271746a20d81a5f3efca17">+8/-8</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > <details> <summary> Need help?</summary><li>Type <code>/help how to ...</code> in the comments thread for any questions about PR-Agent usage.</li><li>Check out the <a href="https://qodo-merge-docs.qodo.ai/usage-guide/">documentation</a> for more information.</li></details> (cherry picked from commit 1f55db2)
|
API Changes --- prev.txt 2025-03-12 10:51:14.026417687 +0000
+++ current.txt 2025-03-12 10:51:10.136377395 +0000
@@ -5533,11 +5533,11 @@
TYPES
type AccessLogsConfig struct {
- // Enabled controls enabling the transaction logs. Default: false.
+ // Enabled controls the generation of access logs by the Gateway. Default: false.
Enabled bool `json:"enabled"`
- // Template configures which fields to log into the access log.
- // If unconfigured, all fields listed will be logged.
+ // Template configures which fields to include in the access log.
+ // If no template is configured, all available fields will be logged.
//
// Example: ["client_ip", "path"].
//
@@ -5676,7 +5676,7 @@
// Custom hostname for the Control API
ControlAPIHostname string `json:"control_api_hostname"`
- // Set this to expose the Tyk Gateway API on a separate port. You can protect it behind a firewall if needed. Please make sure you follow this guide when setting the control port https://tyk.io/docs/planning-for-production/#change-your-control-port.
+ // Set this to expose the Tyk Gateway API on a separate port. You can protect it behind a firewall if needed. Please make sure you follow this guide when setting the control port https://tyk.io/docs/tyk-self-managed/#change-your-control-port.
ControlAPIPort int `json:"control_api_port"`
// This should be changed as soon as Tyk is installed on your system.
@@ -5749,7 +5749,7 @@
Policies PoliciesConfig `json:"policies"`
// Defines the ports that will be available for the API services to bind to in the format
- // documented here https://tyk.io/docs/key-concepts/tcp-proxy/#allowing-specific-ports.
+ // documented here https://tyk.io/docs/api-management/non-http-protocols/#allowing-specific-ports.
// Ports can be configured per protocol, e.g. https, tls etc.
// If configuring via environment variable `TYK_GW_PORTWHITELIST` then remember to escape
// JSON strings.
@@ -6024,7 +6024,7 @@
NewRelic NewRelicConfig `json:"newrelic"`
- // Enable debugging of your Tyk Gateway by exposing profiling information through https://tyk.io/docs/troubleshooting/tyk-gateway/profiling/
+ // Enable debugging of your Tyk Gateway by exposing profiling information through https://tyk.io/docs/api-management/troubleshooting-debugging
HTTPProfile bool `json:"enable_http_profiler"`
// Enables the real-time Gateway log view in the Dashboard.
@@ -6083,7 +6083,7 @@
GlobalSessionLifetime int64 `bson:"global_session_lifetime" json:"global_session_lifetime"`
// This section enables the use of the KV capabilities to substitute configuration values.
- // See more details https://tyk.io/docs/tyk-configuration-reference/kv-store/
+ // See more details https://tyk.io/docs/tyk-self-managed/#store-configuration-with-key-value-store
KV struct {
Consul ConsulConfig `json:"consul"`
Vault VaultConfig `json:"vault"`
@@ -6099,7 +6099,7 @@
// The secret value may be used as `secrets://key1` from the API definition.
// In versions before gateway 5.3, only `listen_path` and `target_url` fields
// have had the secrets replaced.
- // See more details https://tyk.io/docs/tyk-configuration-reference/kv-store/#how-to-access-the-externally-stored-data
+ // See more details https://tyk.io/docs/tyk-self-managed/#how-to-access-the-externally-stored-data
Secrets map[string]string `json:"secrets"`
// Override the default error code and or message returned by middleware.
@@ -6126,7 +6126,7 @@
// ```
OverrideMessages map[string]TykError `bson:"override_messages" json:"override_messages"`
- // Cloud flag indicates that the Gateway is deployed in a Tyk Cloud data plane.
+ // Cloud flag shows the Gateway runs in Tyk Cloud.
Cloud bool `json:"cloud"`
// Skip TLS verification for JWT JWKs url validation
@@ -6352,7 +6352,7 @@
// Start your Gateway HTTP server on specific server name
ServerName string `json:"server_name"`
- // Minimum TLS version. Possible values: https://tyk.io/docs/basic-config-and-security/security/tls-and-ssl/#values-for-tls-versions
+ // Minimum TLS version. Possible values: https://tyk.io/docs/api-management/certificates#supported-tls-versions
MinVersion uint16 `json:"min_version"`
// Maximum TLS version.
@@ -6374,7 +6374,7 @@
// Disable automatic character escaping, allowing to path original URL data to the upstream.
SkipTargetPathEscaping bool `json:"skip_target_path_escaping"`
- // Custom SSL ciphers. See list of ciphers here https://tyk.io/docs/basic-config-and-security/security/tls-and-ssl/#specify-tls-cipher-suites-for-tyk-gateway--tyk-dashboard
+ // Custom SSL ciphers applicable when using TLS version 1.2. See the list of ciphers here https://tyk.io/docs/api-management/certificates#supported-tls-cipher-suites
Ciphers []string `json:"ssl_ciphers"`
// MaxRequestBodySize configures a maximum size limit for request body size (in bytes) for all APIs on the Gateway.
@@ -6388,7 +6388,7 @@
// A value of zero (default) means that no maximum is set and API requests will not be tested.
//
// See more information about setting request size limits here:
- // https://tyk.io/docs/basic-config-and-security/control-limit-traffic/request-size-limits/#maximum-request-sizes
+ // https://tyk.io/docs/api-management/traffic-transformation/#request-size-limits
MaxRequestBodySize int64 `json:"max_request_body_size"`
}
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
lghiur
deleted the
merge/release-5.8.0/1f55db2512a762bf408e49aa8f4ca3c9d771dbbf
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User description
TT-14170 adjusted godoc for gw config (#6938)
User description
TT-14170
Updated GW config godocs
PR Type
Description
Updated access log documentation for Gateway.
Revised TLS version and SSL ciphers documentation links.
Modified control API port comment and link.
Updated KV store and secrets documentation references.
Changes walkthrough 📝
config.go
Update godoc comments for Gateway configuration.config/config.go
HttpServerOptionsConfig.
...in the comments thread for any questions about PR-Agentusage.
for more information.
PR Type
Description
Updated access logs doc comment wording.
Revised TLS and SSL doc URLs.
Modified control API port and KV store links.
Refined godoc comments for Gateway configuration.
Changes walkthrough 📝
config.go
Revise godoc comments and documentation URLs.config/config.go