fix(openapi): correct YAML quote indentation for spec compliance#414
Open
abdelhadi703 wants to merge 1 commit into
Open
fix(openapi): correct YAML quote indentation for spec compliance#414abdelhadi703 wants to merge 1 commit into
abdelhadi703 wants to merge 1 commit into
Conversation
Fix closing single quotes in multiline YAML strings that were placed at column 0 instead of matching the indentation level of their opening quotes (24 spaces). This affected 5 multiline markdown content strings in the OCR endpoint example response. While PyYAML accepts this, stricter YAML parsers may reject the incorrect indentation, making the spec non-portable. Fixes mistralai#379
|
@abdelhadi703 is attempting to deploy a commit to the Mistral AI Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
Hi @mistralai/team, Gentle ping on this OpenAPI spec fix. It corrects YAML quote indentation for spec compliance. Ensures proper parsing by tools. Thanks! |
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
Fixes closing single quotes in multiline YAML strings within
openapi.yamlthat were incorrectly placed at column 0 instead of matching the indentation level of their opening quotes (24 spaces).Changes
/v1/ocr) example response that had incorrect indentation (lines 1984, 2001, 2022, 2039, 2050)markdownfield values in theuserExampleresponseWhy
While PyYAML tolerates closing quotes at any indentation level, stricter YAML parsers reject this as invalid YAML syntax. The incorrect indentation makes the OpenAPI spec non-portable across different YAML processing tools.
Verification
yaml.safe_load)openapi-spec-validatorFixes #379