docs(size-analysis): Document status check rules API#17558
Open
cameroncooke wants to merge 3 commits intomasterfrom
Open
docs(size-analysis): Document status check rules API#17558cameroncooke wants to merge 3 commits intomasterfrom
cameroncooke wants to merge 3 commits intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Document how external CI consumers can fetch Size Analysis status check rules and interpret the machine-readable filter response. Cover filter grouping semantics, decoded literal values, invalid filter handling, and artifact type mapping. Refs EME-1061 Co-Authored-By: OpenAI Codex <noreply@openai.com>
cameroncooke
force-pushed
the
cameroncooke/docs/eme-1061-size-status-rules-api
branch
from
8ba1209 to
b5d91be
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
mtopo27
approved these changes
Apr 30, 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.
Document the new Size Analysis status check rules API for external CI consumers. The docs explain how to fetch the current rule configuration, how to interpret thresholds, and how the machine-readable filter response maps to Sentry's runtime rule evaluation.
Filter Semantics
The page now calls out that separate filter objects are ANDed, conditions inside a filter are ORed, and same-key positive and negative groups can both appear. It also documents
filters: []versusfilters: null,in/notIn, decoded literal values, missing metadata behavior, and artifact type mapping.API Reference Preview Note
This PR links the Size Analysis CI guide to the generated API reference page:
/api/mobile-builds/retrieve-size-analysis-status-check-rules-for-a-project/That page is generated from the Sentry OpenAPI schema, so it may 404 in this docs preview until the companion Sentry PR lands and the updated schema is published/bumped in
sentry-docs.Local Preview Instructions
To preview the generated API reference page locally before the schema cascade lands:
In the
sentryrepo, check out the companion Sentry branch unless the Sentry PR has already landed inmaster:cd /Volumes/Developer/sentry git checkout cameroncooke/feat/eme-1061-size-status-rules-apiGenerate the OpenAPI schema from that Sentry branch:
PATH="$PWD/.venv/bin:$PATH" make build-api-docsThis writes the local schema to:
In the
sentry-docsrepo, run the dev server with that local schema:cd /Volumes/Developer/sentry-docs OPENAPI_LOCAL_PATH=/Volumes/Developer/sentry/tests/apidocs/openapi-derefed.json \ DISABLE_THUMBNAILS=1 \ pnpm devOpen the generated endpoint page:
Refs EME-1061