📝 Add schema view and drift comparison to API endpoints docs#37785
Merged
Conversation
Contributor
Preview links (active after the
|
This comment has been minimized.
This comment has been minimized.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Expanded the comparison of declared and inferred schemas by adding severity levels and detailed descriptions of potential differences. Included specific areas of schema changes that can occur and clarified which differences are excluded to reduce noise. This improves the clarity and usability of the documentation for users comparing API schemas.
Explain that the inferred schema filters fields by observation count and recency, reducing false-positive drift from one-off or attacker traffic.
mauricesvay
force-pushed
the
msvay/api-endpoints-schema-view
branch
from
592c75a to
a59cc1c
Compare
Contributor
Author
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Nice cleanup — pass on the terminology and style changes, plus a solid new section on schema comparison. A few small style/consistency nits below.
Reviewed a59cc1c0cc76a067bcd85d17fd8b65e31851c4cd — workflow run
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
domalessi
reviewed
Jul 1, 2026
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
domalessi
reviewed
Jul 1, 2026
domalessi
left a comment
domalessi
left a comment
Contributor
There was a problem hiding this comment.
Left some feedback. Let me know if you have any Qs, and hit me up when ready for another look!
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…tory/api_endpoints.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
domalessi
approved these changes
Jul 2, 2026
Contributor
There was a problem hiding this comment.
Let's crop this photo to cut out the lefthand edge with the product symbols. That left-hand nav tends to change frequently, and we also want to keep out that little face pic lol
Contributor
Author
There was a problem hiding this comment.
Sorry, I merged before doing the update. I'll open another PR for the edits.
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
1 task
mauricesvay
added a commit
that referenced
this pull request
Jul 6, 2026
* 📝 Crop API endpoint schema screenshot Removes the left-hand nav from the screenshot per review feedback on #37785. * fix: use new filename for cropped API endpoint schema screenshot Avoids cache invalidation issues by keeping the original image filename intact and referencing the cropped version under a new name.
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.
What does this PR do? What is the motivation?
Adds a new "View and compare API schemas" section to the API endpoints page, covering:
Merge readiness
AI assistance
Used Claude Code for initial draft.
Additional notes