OAS 2.1 cleanup#38
Open
hrdlickap wants to merge 1 commit into
Open
Conversation
OAS 2.1 cleanup per programmer answers (Q1–Q5, A1–A5)
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
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.
API 2.1 cleanup
Consistency and accuracy pass over the 2.1 spec. Bundles and lints clean (
redocly lint→ 0 warnings).Schema
proposal(all*ValidationResultschemas): modelled asstringwith examples instead of a fixed enum. The value is generated from the validity ofresult, the validity ofresultCorrected, and the presence ofsuggestions, so the set of values isn't fixed.description: modelled as a nullable string (type: [string, "null"]) rather than an enum, since the message text can change and may be null for some errors.client.ip: now documented as an IPv4 or IPv6 address (used for geolocation), with examples for both.Servers & versioning
/v2.1path server and the duplicated per-operationserversblocks. The API version is selected through theApi-Versionheader.Content
dataSourcedefinitions.app.foxentry.com/registration.Tooling
bundle.sh.Verification