Skip to content

OAS 2.1 cleanup#38

Open
hrdlickap wants to merge 1 commit into
mainfrom
oas-2.1-cleanup
Open

OAS 2.1 cleanup#38
hrdlickap wants to merge 1 commit into
mainfrom
oas-2.1-cleanup

Conversation

@hrdlickap

Copy link
Copy Markdown

API 2.1 cleanup

Consistency and accuracy pass over the 2.1 spec. Bundles and lints clean (redocly lint → 0 warnings).

Schema

  • proposal (all *ValidationResult schemas): modelled as string with examples instead of a fixed enum. The value is generated from the validity of result, the validity of resultCorrected, and the presence of suggestions, so the set of values isn't fixed.
  • Error 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

  • Removed the /v2.1 path server and the duplicated per-operation servers blocks. The API version is selected through the Api-Version header.

Content

  • Regenerated the Supported countries table in the API description from the dataSource definitions.
  • Unified the registration link to app.foxentry.com/registration.
  • Fixed typos in a few descriptions.

Tooling

  • Removed an unreachable branch in bundle.sh.

Verification

redocly bundle openapi.yaml
redocly lint openapi.yaml    # valid, 0 warnings

OAS 2.1 cleanup per programmer answers (Q1–Q5, A1–A5)
@hrdlickap hrdlickap requested a review from MartinPrivoznik July 7, 2026 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant