Skip to content

Conversation

@captainsafia
Copy link
Member

@captainsafia captainsafia commented Aug 14, 2024

uid: fundamentals/openapi/buildtime-openapi
---

# Generate OpenAPI documents at build-time
Copy link
Member Author

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.

Copy link
Contributor

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.

@Rick-Anderson Rick-Anderson marked this pull request as draft August 14, 2024 20:27
@Rick-Anderson Rick-Anderson changed the title Add build-time OpenAPI generation docs FROZEN: Add build-time OpenAPI generation doc Aug 14, 2024
@Rick-Anderson Rick-Anderson self-assigned this Aug 14, 2024
@captainsafia
Copy link
Member Author

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.

Copy link
Contributor

@mikekistler mikekistler left a 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.

@captainsafia captainsafia changed the title FROZEN: Add build-time OpenAPI generation doc Add build-time OpenAPI generation doc Oct 24, 2024
@captainsafia
Copy link
Member Author

@Rick-Anderson @tdykstra Can I get another content review before we merge this?

Copy link
Contributor

@tdykstra tdykstra left a 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.

@captainsafia captainsafia marked this pull request as ready for review October 26, 2024 00:26
@captainsafia
Copy link
Member Author

I'm gonna go ahead and merge this so we can iterate on the ToC and content in future PRs.

@captainsafia captainsafia merged commit 8c20451 into main Oct 26, 2024
3 checks passed
@captainsafia captainsafia deleted the openapi-build-docs branch October 26, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants