docs: sync translated READMEs with Pydantic-first Quick Start - #303
Merged
Conversation
Bring ko/ja/zh-CN Quick Start and Before/After into parity with the English README: lead with request_model=/response_model= Pydantic models, fold the spec/Swagger UI plumbing into a <details> block, preserve the raw JSON Schema path under an Advanced <details>, add the localized "documents, not validates" note, and remove the outdated-translation banner now that each file is synced. Closes #291
There was a problem hiding this comment.
Pull request overview
This PR updates the Korean, Japanese, and Simplified Chinese READMEs to match the current English “Pydantic-first” Quick Start structure, keeping the localized docs aligned with the recommended usage patterns for azure-functions-openapi.
Changes:
- Adds localized Before / After sections demonstrating the Pydantic
request_model=/response_model=workflow. - Reworks Quick Start examples to rely on
@openapiroute/method inference from@app.route, and folds spec/Swagger UI wiring into a<details>block. - Preserves the raw JSON Schema approach under an Advanced
<details>section and adds the localized “documents, not validates” note.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.ko.md | Syncs Korean README to the English Pydantic-first Quick Start structure, including details blocks and advanced raw-schema example. |
| README.ja.md | Syncs Japanese README to the English Pydantic-first Quick Start structure, including details blocks and advanced raw-schema example. |
| README.zh-CN.md | Syncs Simplified Chinese README to the English Pydantic-first Quick Start structure, including details blocks and advanced raw-schema example. |
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
Brings the ko/ja/zh-CN READMEs back into parity with the English Pydantic-first Quick Start (reworked in #290 / #289).
request_model=/response_model=Pydantic models.@openapiinfers route/method from@app.route, and theopenapi.json/openapi.yaml/docsplumbing is folded into a<details>block.<details>section.azure-functions-validation)" note to each handler.Verification
ast.parse(5 blocks each, matching the English README).Closes #291