feat(schema): add SHOULD for capability_id on every format_options[] entry#4863
Closed
bokelley wants to merge 1 commit into
Closed
feat(schema): add SHOULD for capability_id on every format_options[] entry#4863bokelley wants to merge 1 commit into
bokelley wants to merge 1 commit into
Conversation
…try (#4856) Pairs the seller-side obligation with the V2 buyer capability added in #4845. Sellers SHOULD publish a stable capability_id on every format_options[] entry so v2 buyers using PackageRequest.capability_ids[] can target declarations directly. https://claude.ai/code/session_017v9EZzS9ZFzexe58cmFc4k
Contributor
Author
|
Closing as superseded by current main. The capability_id SHOULD guidance and changeset are already present in |
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
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.
Closes #4856
Summary
product-format-declaration.jsoncapability_iddescription update: sellers SHOULD publish a stablecapability_idon everyformat_options[]entry — not just when structurally required to disambiguate. Pairs the seller-side obligation with the v2 buyer capability (PackageRequest.capability_ids[]) added in #4845, so sellers reading 3.1 release notes see the obligation alongside the capability in the same minor.The change also:
Sellers SHOULD NOT change a published capability_id(normative, consistent withdisplay_name's pattern)reasonfield inpackage-request.jsonNon-breaking justification: Description-only change. The
capability_idfield remainstype: stringand optional in JSON Schema (requiredarray unchanged). Existing conformant implementations remain conformant — sellers who omitcapability_idon single-format_kindentries stay valid; the SHOULD creates a normative recommendation, not a mandatory requirement.Not patch-eligible for 3.0.x. The prior description was "Recommended for any declaration that may be referenced by capability_id over time" (informal). Adding explicit RFC 2119 SHOULD language fails the patch-eligibility test (a conformant 3.0.0 implementation that omits
capability_identirely is valid but does not satisfy the new SHOULD). Ships onmainas3.1.0-beta.Nunder pre-mode — correct and intentional.Pre-PR review:
minorchangeset correct; REQUIRED + SHOULD combination is coherent and consistent with existing patterns in this schemaSession: https://claude.ai/code/session_017v9EZzS9ZFzexe58cmFc4k
Generated by Claude Code