-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Add build-time OpenAPI generation doc #33359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| uid: fundamentals/openapi/buildtime-openapi | ||
| --- | ||
|
|
||
| # Generate OpenAPI documents at build-time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Rick-Anderson @tdykstra This definitely needs some massaging for prose and formatting but the material covered is true to what I think we should cover. Feel free to modify this branch as you see fit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Rick-Anderson @tdykstra This definitely needs some massaging for prose and formatting but the material covered is true to what I think we should cover. Feel free to modify this branch as you see fit.
Can I merge #33361 into this branch? You've reviewed #33361 and @mikekistler has approved my changes. My PR fixes the toc.yml merge conflict. I think I can easily fix the other merge conflicts.
2698d41 to
2f05a5a
Compare
|
OK! I've rebased this PR and resolved the merge conflicts. @mikekistler We talked about doing another revamp on the Table of Contents alongside this change. Are you OK with merging this PR and making the Table of Contents change in another one? Alternatively, if we want the ToC to stay in a nice state we can fix it here. |
mikekistler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine to defer the TOC revamp to a later PR as long as that doesn't force us to add redirects for ephemeral pages added here.
|
@Rick-Anderson @tdykstra Can I get another content review before we merge this? |
tdykstra
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, I noted just a few minor issues.
Co-authored-by: Tom Dykstra <[email protected]>
|
I'm gonna go ahead and merge this so we can iterate on the ToC and content in future PRs. |
EDIT by @Rick-Anderson
All commit and suggestions should be made in #33361
#33361 will merge into this PR
----------- END of edit -----------
Adding a new page to document our build-time OpenAPI document generation capabilities.
Internal previews