Add 12-month minimum deprecation cycle to @API element annotations#167
Open
mordavidj wants to merge 1 commit into
Open
Add 12-month minimum deprecation cycle to @API element annotations#167mordavidj wants to merge 1 commit into
mordavidj wants to merge 1 commit into
Conversation
Documents the SAP lifecycle policy requiring elements stay in DEPRECATED state for at least 12 months before DECOMMISSIONED, makes successor mandatory (with explicit justification if absent), and aligns decommissioningPlannedForYearMonth with the same 12-month constraint. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
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.
Summary
DEPRECATEDrelease state description to clarify the field remains fully functional and continues to deliver data, and that it must stay in this state for a minimum of 12 months before transitioning toDECOMMISSIONEDDECOMMISSIONEDrelease state description to explicitly state it may only be applied after 12 months in theDEPRECATEDstatesuccessorfrom a recommendation to a mandatory requirement (with an explicit justification escape hatch if no direct successor exists)decommissioningPlannedForYearMonthto note the planned date must be at least 12 months after the deprecation dateThese changes align the annotation semantics with SAP lifecycle policies as documented in:
DRAFT Deprecation Guidance for SAP‑Managed Fields in Released Data Products
Test plan
spec/v1/annotations/api.yamlfor accuracy and alignment with the wiki guidance🤖 Generated with Claude Code