Only Include Public APIs & Their Schemas#229
Merged
Merged
Conversation
…s from openapi.json + dead page cleanup
ihassanein
requested review from
aaparent,
aviau,
ireydiak,
jenip13 and
xvaier
as code owners
ihassanein
commented
Jul 8, 2026
Contributor
Author
There was a problem hiding this comment.
Removed as it is not a public api endpoint and was likely kept by mistake as it has not been added to docs.json
ihassanein
commented
Jul 8, 2026
Contributor
Author
There was a problem hiding this comment.
Removed as it is not a public api endpoint and was likely kept by mistake as it has not been added to docs.json
ihassanein
commented
Jul 8, 2026
Contributor
Author
There was a problem hiding this comment.
Removed as it is not a public api endpoint and was likely kept by mistake as it has not been added to docs.json
xvaier
approved these changes
Jul 8, 2026
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
2 participants
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.
Whenever someone runs the generate scripts for the first time they get intimidated by the massive diff this creates. It's a two-fold issue:
*openapi.jsonfiles the V4 includes all the endpoints not just public ones. In all cases we also keep schemas that are used by private endpoints.This inspired me to add more post-processing to filter on a tag we already include in V4 endpoints 🎉 V2 and V3 already only include routes we want to document so they are unaffected by this post-processing step.
When testing I saw the diff was still massive, so I further added a step to remove unused schemas (these are typically for our private endpoints so they are not going to be referenced)
Let me know what you think, I did this between tasks using Claude to write the code and I triple checked that the behaviour made sense as well as ran the local docs and clicked everywhere to assure no references were broken by this change.