Repository navigation
Conversation
Merging this PR will leave 2 of 36 operations untested. Please review.
❌ Untested (2)
🟡 Tested (34)
24 more
Powered by TraceCov v0.25.5 schemathesis 4.31.1 | http://localhost:8081/exist/restxq/v1/openapi.yaml |
The sidebar of Scalar (and other renderers) lists endpoints by their summary, which made individual endpoints hard to find. Summaries now follow the pattern "Scope: Thing (format)", e.g. "Corpus: Play metadata (CSV)" or "Play: Network data (GEXF)". This also gives the JSON and CSV variants of the corpus metadata endpoint distinct summaries. Details dropped from the summaries are covered by the descriptions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The public endpoints were all under a single "public" tag. They are now
split into General, Corpora, Plays, Texts, Networks and Characters, so
that for instance all data for network analysis is found in one place.
The other tags are capitalised to match.
x-tagGroups additionally groups the tags in the Scalar sidebar. Swagger
UI ignores the extension and lists the tags flat in the order of the
tags array, which is why the tags make sense without their groups.
/id/{id} is under General instead of Plays as it may also resolve other
identifiers like corpus names in the future.
The Schemathesis tag filters and the Scalar anchor links in parameter
descriptions follow the new tag names.
Closes #214
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
cmil
force-pushed
the
openapi-summaries
branch
from
October 24, 2026 22:50
a995879 to
95ad389
Compare
This branch was successfully deployed
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.
Makes the API documentation easier to navigate in Scalar and on swagger.dracor.org: endpoint summaries get a resource prefix (e.g. "Play: Network data (GEXF)"), and the catch-all
publictag is split by functionality, withx-tagGroupsfor the Scalar sidebar.To check:
webhook→Webhook,admin→Admin)x-tagGroupsand lists the tags flatCloses #214
🤖 Generated with Claude Code