Document allowed_api_keys in track upload/update request bodies#784
Merged
rickyrombo merged 1 commit intomainfrom May 5, 2026
Merged
Document allowed_api_keys in track upload/update request bodies#784rickyrombo merged 1 commit intomainfrom
rickyrombo merged 1 commit intomainfrom
Conversation
The track response schema already documents allowed_api_keys, but the create_track_request_body and update_track_request_body schemas were missing it. The Go request structs already accept and forward the field — only the OpenAPI documentation was lying about the request shape. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the OpenAPI v1 specification to fully document the existing allowed_api_keys request field for track creation and updates, aligning the docs with the already-implemented Go request structs and handler behavior.
Changes:
- Added
allowed_api_keystocreate_track_request_bodyschema. - Added
allowed_api_keystoupdate_track_request_bodyschema.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
The track response schema already documents
allowed_api_keys, but thecreate_track_request_bodyandupdate_track_request_bodyschemas in the OpenAPI spec did not include it. The Go request structs (UploadTrackRequest,UpdateTrackRequestinapi/v1_track.go) already declare the field with theallowed_api_keysJSON tag, and the PUT/POST handlers already forward the full request body into the entity-manager metadata blob — only the OpenAPI documentation was incomplete.This adds the field to both request body schemas. Once merged and synced, it'll also fix the rendered SDK / API reference on the docs site.
Test plan
swagger validateor rendering in the docs site)🤖 Generated with Claude Code