fix(spec): validate top-level OpenAPI versions - #416
Draft
saltbo wants to merge 2 commits into
Draft
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
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.
What changed
openapifieldsWhy
Spec discovery probes the API root, advertised
service-desclinks, and well-known OpenAPI paths concurrently. A service root representation such as:{"name":"Example API","openapi":"https://api.example.com/openapi.json"}was accepted as an OpenAPI document because detection searched for the word
openapianywhere in a generic JSON/YAML body. If that root probe completed first, Restish cached an empty operation set instead of using the advertised OpenAPI document.The OpenAPI Object requires
openapito be a top-level specification version. Validating that boundary rejects service metadata while leaving the existing discovery probes to select the real document.Impact
Generated commands are now stable for APIs whose root metadata publishes an OpenAPI URL under an
openapifield. Existing valid OpenAPI 3.x documents, including documents with a late top-level version field, continue to load.Verification
go test ./internal/spec -count=1go test ./internal/cli -count=1go test -race ./internal/spec ./internal/cligo vet ./internal/spec ./internal/cligo test ./...passes all packages except the pre-existing localcmd/restish-pkcs11build failure caused by unavailable PKCS#11/cgo symbols ingithub.com/ThalesIgnite/crypto11