feat(openapi): document utilization; add utilizedPercentage to postag…#5466
Open
martinconic wants to merge 1 commit into
Open
feat(openapi): document utilization; add utilizedPercentage to postag…#5466martinconic wants to merge 1 commit into
martinconic wants to merge 1 commit into
Conversation
martinconic
requested review from
acud,
akrem-chabchoub,
gacevicljubisa,
janos and
sbackend123
akrem-chabchoub
approved these changes
May 20, 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.
Checklist
Description
Closes #5226
Adds a description to the existing PostageBatch.utilization property in
the OpenAPI spec, clarifying that it is a raw bucket-count value (not a
usage percentage) and giving the formula for fractional usage.
Adds a new utilizedPercentage field to the /stamps and
/stamps/{batchID} responses, exposing utilization / 2^(depth -
bucketDepth) as a float in [0, 1] so API consumers don't have to derive
it themselves and can't accidentally treat the raw utilization as a
percentage.
Open API Spec Version Changes (if applicable)
Motivation and Context (Optional)
Related Issue (Optional)
Screenshots (if appropriate):
AI Disclosure