Skip to content

OAS 2.1 cleanup - #38

Merged
MartinPrivoznik merged 2 commits into
mainfrom
oas-2.1-cleanup
Jul 21, 2026
Merged

OAS 2.1 cleanup#38
MartinPrivoznik merged 2 commits into
mainfrom
oas-2.1-cleanup

Conversation

@hrdlickap

@hrdlickap hrdlickap commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

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): documented as a string with the complete list of possible values, plus an explanation of how the value is composed (validity of result × validity of resultCorrected × presence of suggestions). email/validate additionally documents the unknown* variants. It is never null.
  • 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.
  • Reworded the registration note and unified the link to app.foxentry.com/registration.
  • Fixed typos in a few descriptions.

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
Comment thread bundle.sh
Comment thread openapi.yaml Outdated
Comment thread components/schemas/requests/ClientRequest.yaml
Comment thread components/schemas/results/company/CompanyValidationResult.yaml
Comment thread components/schemas/results/email/EmailValidationResult.yaml
Comment thread components/schemas/results/location/LocationValidationResult.yaml
Comment thread components/schemas/results/name/NameValidationResult.yaml
Comment thread components/schemas/results/phone/PhoneValidationResult.yaml
@hrdlickap

Copy link
Copy Markdown
Contributor Author

Updated per review: full proposal value list, bundle.sh fail-fast restored, registration wording reworded.

Also fixed ErrorValueGlobal.yaml, where an enum was left alongside the new nullable type — now consistent with the other error schemas.

redocly lint → 0 warnings.

@MartinPrivoznik
MartinPrivoznik merged commit e43af9b into main Jul 21, 2026
1 check passed
@MartinPrivoznik
MartinPrivoznik deleted the oas-2.1-cleanup branch July 21, 2026 16:08
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.

2 participants