-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TT-11185] release docs 5.3.0 update (#6079)
## This PR addresses feedback raised up in DX review. - fixes typos - removes oxford comma - rewords some unclear docs - adds docs - consistent docs for `enabled` fields Focuses on x-tyk-gateway.md docs (apidef/oas). ___ ## **Type** enhancement, documentation ___ ## **Description** - Updated comments across various structs for better clarity and consistency. - Changed phrasing from "Enabled enables" to "Enabled activates" to improve readability. - Enhanced documentation for authentication modes, middleware configurations, operation structs, security configurations, server configurations, upstream configurations, and URL rewriting. - Added detailed examples and explanations where necessary to aid understanding. ___ ## **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>authentication.go</strong><dd><code>Improved Authentication Structs Documentation and Clarity</code></dd></summary> <hr> apidef/oas/authentication.go <li>Updated comments for clarity and consistency across authentication <br>structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for various <br>authentication modes.<br> <li> Improved documentation for HMAC, OIDC, CustomPluginAuthentication, and <br>AuthenticationPlugin. </details> </td> <td><a href="https://pull/6079/files#diff-e51c9d24d4235e7cc53048cc1d92967d177585ba5e073f14876308a97bef6326">+12/-10</a> </td> </tr> <tr> <td> <details> <summary><strong>middleware.go</strong><dd><code>Enhanced Middleware Documentation and Consistency</code> </dd></summary> <hr> apidef/oas/middleware.go <li>Updated comments for clarity and consistency across middleware <br>structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for various <br>middleware configurations.<br> <li> Added detailed comments for <code>AllowedAlgorithms</code> in <code>HMAC</code> and improved <br>documentation for custom plugins. </details> </td> <td><a href="https://pull/6079/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+20/-16</a> </td> </tr> <tr> <td> <details> <summary><strong>operation.go</strong><dd><code>Refined Operation Structs Documentation for Better Clarity</code></dd></summary> <hr> apidef/oas/operation.go <li>Updated comments for clarity and consistency across operation structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for mock response and <br>FromOASExamples.<br> <li> Improved documentation for <code>MockResponse</code> and <code>FromOASExamples</code>. </details> </td> <td><a href="https://pull/6079/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+3/-3</a> </td> </tr> <tr> <td> <details> <summary><strong>security.go</strong><dd><code>Updated Security Structs Documentation for Enhanced Clarity</code></dd></summary> <hr> apidef/oas/security.go <li>Updated comments for clarity and consistency across security structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for token, basic <br>authentication, and OAuthProvider.<br> <li> Enhanced documentation for <code>JWTValidation</code> and <code>Introspection</code> structs. </details> </td> <td><a href="https://pull/6079/files#diff-15e7d47137452ca4f3f6139aa8c007cdb426152c41846f712f8bf5dfb607afcc">+18/-11</a> </td> </tr> <tr> <td> <details> <summary><strong>server.go</strong><dd><code>Improved Server Configuration Documentation and Consistency</code></dd></summary> <hr> apidef/oas/server.go <li>Updated comments for clarity and consistency across server <br>configuration structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for various server <br>configurations.<br> <li> Improved documentation for <code>ListenPath</code>, <code>ClientCertificates</code>, and <br><code>GatewayTags</code>. </details> </td> <td><a href="https://pull/6079/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+9/-9</a> </td> </tr> <tr> <td> <details> <summary><strong>upstream.go</strong><dd><code>Enhanced Upstream Configuration Documentation for Better Understanding</code></dd></summary> <hr> apidef/oas/upstream.go <li>Updated comments for clarity and consistency across upstream <br>configuration structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for ServiceDiscovery <br>and MutualTLS.<br> <li> Enhanced documentation for <code>RateLimit</code> and <code>ServiceDiscoveryCache</code>. </details> </td> <td><a href="https://pull/6079/files#diff-7b0941c7f37fe5a2a23047e0822a65519ca11c371660f36555b59a60f000e3f4">+6/-6</a> </td> </tr> <tr> <td> <details> <summary><strong>url_rewrite.go</strong><dd><code>Refined URL Rewrite Documentation with Detailed Examples</code> </dd></summary> <hr> apidef/oas/url_rewrite.go <li>Updated comments for clarity and consistency in URLRewrite struct.<br> <li> Changed "Enabled enables" to "Enabled activates" for URL rewriting.<br> <li> Added detailed examples and explanations for <code>URLRewriteRule</code> fields. </details> </td> <td><a href="https://pull/6079/files#diff-7317c6061fb6488e079d733230045c7cbc1b4b2ffb98bb7da20d4025f4976e51">+8/-4</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > ✨ **PR-Agent usage**: >Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions --------- Co-authored-by: Tit Petric <tit@tyk.io>
- Loading branch information
Showing
9 changed files
with
83 additions
and
66 deletions.
There are no files selected for viewing
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
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
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
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
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
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
Oops, something went wrong.