Merging to release-5.11: [DX-2102] Bug Fixes and Improvements in Tyk OAS (#7419) #7620
+0
−0
Conversation
This file contains hidden or 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
Cherry-pick failed with conflicts and requires manual resolution.
This empty commit exists to allow opening a draft PR.
7 tasks
…0bef59436b82f362564c20f/DX-2102
…0bef59436b82f362564c20f/DX-2102
<!-- Provide a general summary of your changes in the Title above --> Improved Tyk OAS documentation as per the Jira https://tyktech.atlassian.net/browse/DX-2102 Changes have already been added in the [docs](https://github.com/TykTechnologies/tyk-docs/pull/6949) <!-- Describe your changes in detail --> <!-- This project only accepts pull requests related to open issues. --> <!-- If suggesting a new feature or change, please discuss it in an issue first. --> <!-- If fixing a bug, there should be an issue describing it with steps to reproduce. --> <!-- OSS: Please link to the issue here. Tyk: please create/link the JIRA ticket. --> <!-- Why is this change required? What problem does it solve? --> <!-- Please describe in detail how you tested your changes --> <!-- Include details of your testing environment, and the tests --> <!-- you ran to see how your change affects other areas of the code, etc. --> <!-- This information is helpful for reviewers and QA. --> <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Refactoring or add test (improvements in base code or adds test coverage to functionality) <!-- Go over all the following points, and put an `x` in all the boxes that apply --> <!-- If there are no documentation updates required, mark the item as checked. --> <!-- Raise up any additional concerns not covered by the checklist. --> - [ ] I ensured that the documentation is up to date - [ ] I explained why this PR updates go.mod in detail with reasoning why it's required - [ ] I would like a code coverage CI quality gate exception and have explained why ___ Documentation ___ - Clarify `Paths` key semantics and examples - Document `Operations` keyed by `operationID` - Expand `State.Internal` exposure behavior details - Fix typo in `ListenPath` strip example ___ ```mermaid flowchart LR Paths["Paths docs"] -- clarify keys/examples --> Middleware["Middleware struct context"] Operations["Operations docs"] -- key is operationID --> Operation["Operation definition"] StateInternal["State.Internal docs"] -- detail exposure behavior --> GatewayExposure["Gateway exposure rules"] ListenPath["ListenPath docs"] -- fix URL typo --> Example["Strip path example"] ``` <details> <summary><h3> File Walkthrough</h3></summary> <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>middleware.go</strong><dd><code>Clarify Paths map keys and context</code> </dd></summary> <hr> apidef/oas/middleware.go <ul><li>Expand <code>Paths</code> comment with Middleware context<br> <li> Explain string keys as URL patterns</ul> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+2/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>operation.go</strong><dd><code>Describe Operations keyed by operationID</code> </dd></summary> <hr> apidef/oas/operation.go - Document `Operations` map keyed by `operationID` </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>root.go</strong><dd><code>Expand Internal field exposure semantics</code> </dd></summary> <hr> apidef/oas/root.go - Elaborate `State.Internal` behavior and references </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>server.go</strong><dd><code>Fix ListenPath strip example URL</code> </dd></summary> <hr> apidef/oas/server.go - Fix base URL typo in strip example </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a> </td> </tr> </table></td></tr></tr></tbody></table> </details> ___ (cherry picked from commit bd0f86e)
<!-- Provide a general summary of your changes in the Title above --> Improved Tyk OAS documentation as per the Jira https://tyktech.atlassian.net/browse/DX-2102 Changes have already been added in the [docs](https://github.com/TykTechnologies/tyk-docs/pull/6949) <!-- Describe your changes in detail --> <!-- This project only accepts pull requests related to open issues. --> <!-- If suggesting a new feature or change, please discuss it in an issue first. --> <!-- If fixing a bug, there should be an issue describing it with steps to reproduce. --> <!-- OSS: Please link to the issue here. Tyk: please create/link the JIRA ticket. --> <!-- Why is this change required? What problem does it solve? --> <!-- Please describe in detail how you tested your changes --> <!-- Include details of your testing environment, and the tests --> <!-- you ran to see how your change affects other areas of the code, etc. --> <!-- This information is helpful for reviewers and QA. --> <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Refactoring or add test (improvements in base code or adds test coverage to functionality) <!-- Go over all the following points, and put an `x` in all the boxes that apply --> <!-- If there are no documentation updates required, mark the item as checked. --> <!-- Raise up any additional concerns not covered by the checklist. --> - [ ] I ensured that the documentation is up to date - [ ] I explained why this PR updates go.mod in detail with reasoning why it's required - [ ] I would like a code coverage CI quality gate exception and have explained why ___ Documentation ___ - Clarify `Paths` key semantics and examples - Document `Operations` keyed by `operationID` - Expand `State.Internal` exposure behavior details - Fix typo in `ListenPath` strip example ___ ```mermaid flowchart LR Paths["Paths docs"] -- clarify keys/examples --> Middleware["Middleware struct context"] Operations["Operations docs"] -- key is operationID --> Operation["Operation definition"] StateInternal["State.Internal docs"] -- detail exposure behavior --> GatewayExposure["Gateway exposure rules"] ListenPath["ListenPath docs"] -- fix URL typo --> Example["Strip path example"] ``` <details> <summary><h3> File Walkthrough</h3></summary> <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>middleware.go</strong><dd><code>Clarify Paths map keys and context</code> </dd></summary> <hr> apidef/oas/middleware.go <ul><li>Expand <code>Paths</code> comment with Middleware context<br> <li> Explain string keys as URL patterns</ul> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+2/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>operation.go</strong><dd><code>Describe Operations keyed by operationID</code> </dd></summary> <hr> apidef/oas/operation.go - Document `Operations` map keyed by `operationID` </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>root.go</strong><dd><code>Expand Internal field exposure semantics</code> </dd></summary> <hr> apidef/oas/root.go - Elaborate `State.Internal` behavior and references </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-9c56b2bdb992e0a7db76809d4c516e1cd61c9486c7f0437b344c0032476af80f">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>server.go</strong><dd><code>Fix ListenPath strip example URL</code> </dd></summary> <hr> apidef/oas/server.go - Fix base URL typo in strip example </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/7419/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+1/-1</a> </td> </tr> </table></td></tr></tr></tbody></table> </details> ___ (cherry picked from commit bd0f86e)
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.
Cherry-pick of
bd0f86e67f07487470bef59436b82f362564c20ffrommastertorelease-5.11requires manual resolution.Conflicts detected: 0
Tips:
git cherry-pick -x bd0f86e67f07487470bef59436b82f362564c20fOriginal commit: bd0f86e