docs: enhance score set create/patch endpoints with detailed OpenAPI schema for file uploads #630
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
…schema for file uploads
…ints by indicating required fields as property
davereinhart
approved these changes
Jan 14, 2026
Collaborator
davereinhart
left a comment
davereinhart
left a comment
There was a problem hiding this comment.
Looks good. I pushed a minor change to define multipart required fields properly.
bencap
deleted the
docs/bencap/610/open-api-docs-for-score-set-metadata
branch
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.
This pull request enhances the OpenAPI documentation for the score set upload and patch endpoints by explicitly defining the multipart form data schema for file uploads and associated metadata. These changes improve API usability and clarity for clients interacting with these endpoints.
OpenAPI schema improvements for file upload endpoints:
openapi_extradefinitions to thecreate_score_setendpoint, specifying the multipart form data schema for required and optional files (scores_file,counts_file,score_columns_metadata,count_columns_metadata), including descriptions and data types.upload_score_set_variant_dataendpoint with an explicit multipart form schema inopenapi_extra, including all updateable score set properties and optional file uploads, improving the OpenAPI documentation for clients.