PATCH: Fix OpenAPI Schema Reference#574
Merged
Merged
Conversation
Corrected the return type of `GET /service_at_locations/{id}` from
`compiled/service.json` to `compiled/service_at_location.json`
Added this to the changelog in the docs.
Ran the compilation step for the docs. Changes to `/schema/openapi.json` resulted in changes to `docs/extras/openapi30.json`.
Contributor
Author
|
This PR will be merged on 2026-01-16 if there are no objections raised. |
Contributor
Author
|
No objections were raised :-) This PR has been merged and I will now create a new PATCH-level release. |
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
1 participant
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.
Description
This PATCH fixes a bug with the
openapi.jsonfile which incorrectly declared the return type of the API EndpointGET /service_at_locations/{id}.This was previously declared as being an instance of the (compiled)
service.jsonschema, which is incorrect since there exists a compiledservice_at_location.jsonschema.This PR addresses this bug, and adds an entry to the changelog which reflects it. The entry in the changelog is pre-emptively hyperlinked to the release of HSDS which would result in this PATCH being merged.
Merge checklist
If you have edited any schema files:
hsds_schema.pyto updatedatapackage.jsonand example files