Add x-cog-accept MIME type annotation for Path/File input fields#2863
Open
markphelps wants to merge 2 commits intomainfrom
Open
Add x-cog-accept MIME type annotation for Path/File input fields#2863markphelps wants to merge 2 commits intomainfrom
markphelps wants to merge 2 commits intomainfrom
Conversation
Add an 'accept' parameter to Input() that specifies allowed MIME types or file extensions for Path/File inputs. The Go static schema generator extracts this and emits it as 'x-cog-accept' in the OpenAPI schema, giving schema consumers (UIs, validators, API clients) visibility into what file types an input expects. Usage: Input(accept="image/*"), Input(accept="audio/wav,audio/mp3"), or Input(accept=".safetensors,.bin"). Using accept on non-Path/File types is a hard build error.
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
acceptparameter toInput()for declaring allowed MIME types / file extensions onPathandFileinputs (e.g.Input(accept="image/*"),Input(accept="audio/wav,audio/mp3"),Input(accept=".safetensors,.bin"))x-cog-acceptin the OpenAPI schema, giving schema consumers (UIs, validators, API clients) visibility into what file types an input expectsaccepton non-Path/File types (e.g.str,int) is a hard build errorExample
Produces:
{ "image": { "type": "string", "format": "uri", "x-cog-accept": "image/*" }, "audio": { "type": "string", "format": "uri", "x-cog-accept": "audio/wav,audio/mp3" } }