You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Updated the OAS reference documentation to improve clarity and consistency in feature naming.
Added new features to the documentation, including "API segment tags", "Upstream load balancing", and a new "Traffic Logs" section.
Enhanced terminology for existing features, such as changing "IP Allowlist" to "IP access control" and "GW Request Signing" to "Client-GW request signing".
Changes walkthrough 📝
Relevant files
Documentation
oas-reference.md
Update and expand OAS reference documentation for clarity and new features
Ensure consistent capitalization in the table headers to maintain uniformity and improve readability. The header 'Api Designer' should be changed to 'API Designer' to match other occurrences and standard capitalization rules.
-| Feature | Implemented | Api Designer |+| Feature | Implemented | API Designer |
|---------------------------------------|------------------|---------------|
Suggestion importance[1-10]: 9
Why: The suggestion correctly identifies an inconsistency in capitalization, which improves readability and maintains uniformity across the document.
9
Standardize feature name capitalization
Correct the inconsistent capitalization in the feature names to maintain a professional and uniform appearance in the document. For example, 'Basic authentication' should be 'Basic Authentication'.
Why: The suggestion improves the document's professionalism and uniformity by correcting inconsistent capitalization in feature names.
9
Standardize the use of special characters for consistency
Correct the inconsistent use of special characters for the 'not implemented' symbol. Replace '❌️' with '❌' to maintain consistency across the document.
Why: The suggestion addresses a minor but valid issue of inconsistent use of special characters, which enhances the document's consistency.
8
Enhancement
Clarify the feature name for better understanding
Update the feature name 'IP access control' to 'IP Allowlist/Blocklist' for clarity and to reflect a more specific functionality, aligning with the previously used terms in the old hunk.
buger
deleted the
merge/release-5.5/7c2d02894809da8caab7f63a35735593ee446b47
branch
August 20, 2024 13:36
dcs3spp
changed the title
Merging to release-5.5: [DX-1624] Updated for 5.4 (#5282)
Merging to release-5.5: [DX-1628] Updated for 5.4 (#5282)
Aug 20, 2024
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
DX-1628 Updated for 5.4 (#5282)
Updated for 5.5
PR Type
Documentation
Description
Changes walkthrough 📝
oas-reference.md
Update and expand OAS reference documentation for clarity and new
features
tyk-docs/content/getting-started/using-oas-definitions/oas-reference.md
balancing".
and "Client-GW request signing".