Fix API/docs parity and add contract validation#26
Merged
andreagrandi merged 1 commit intomasterfrom Mar 14, 2026
Merged
Conversation
… e2e test
- Fix search `q` parameter docs: searches name and description, not address
- Add WEBP to accepted image format docs (submit, report, errors)
- Fix statistics endpoint path prefix in docs and changelog
- Add missing endpoints to rate-limiting table (statistics, community photo)
- Document POST /api/v1/libraries/{slug}/photo endpoint (new docs page)
- Add openapi-spec-validator to CI via nox session
- Fix OpenAPI spec violation: use json_schema_extra for query param examples
- Add end-to-end API integration test covering full user workflow
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.
Summary
qparameter description (name + description, not address), added WEBP to accepted image formats, fixed statistics endpoint path prefix, updated rate-limiting table with missing endpointsdocs/libraries/submit-photo.mdforPOST /api/v1/libraries/{slug}/photo, added to nav, index, getting-started, and changelogopenapi-spec-validatordependency,validate_openapinox session, CI step after tests. Also fixed a pre-existing spec violation (Pydanticexamplesarrays on query params →json_schema_extrawith singularexample)Test plan
nox -s tests)nox -s validate_openapi)