Release Review: NumberRecycling r3.1 (rc Sync26) - #111
Release Review: NumberRecycling r3.1 (rc Sync26)#111camara-release-automation[bot] wants to merge 3 commits into
Conversation
CAMARA Validation — PASS (with warnings)0 errors, 1 warnings, 0 hints | Profile: standard
|
|
|
||
| ### Breaking changes | ||
|
|
||
| * Alignment with whitepaper by @Masa8106 in https://github.com/camaraproject/NumberRecycling/pull/106 |
There was a problem hiding this comment.
Hi all, just to clarify the versioning point: I would not consider the changes introduced in PR #106 a breaking change. The PR does not change the API contract or conformance behavior:
- no endpoint has changed,
- no request or response schema has changed,
phoneNumberRecycledremains a boolean,400 OUT_OF_RANGEalready existed in the API,- and no conformance tests have been modified to enforce a new runtime behavior.
The changes are therefore documentation / semantic clarification, aligning the API guidance with the agreed whitepaper interpretation of specifiedDate and the existing OUT_OF_RANGE response. If in a future release we decide to make a different response mandatory for a scenario that existing implementations currently handle differently, and enforce that through conformance tests, then we should assess that separately as a potential behavioral breaking change.
There was a problem hiding this comment.
@albertoramosmonagas, Thank you for your comment.
First of all, I am not sure what is the definition of breaking change exactly.
As you pointed out, there is no change from aspects of API specificatoin (though Scenario 2 in yaml file was changed) and test feature file.
On the other hand, a response value was changed in a specific case. From API consumer perspective, there is a difference between v0.2 and v0.3. I think it can't be covered by v0.3 and it is a change of non-backward compatibility.
So far I can discuss openly whether this is a breaking change or potential behavioral breaking change.
There was a problem hiding this comment.
You're correct that the Scenario 2 description changed relative to what the v0.2.0 YAML literally stated. However, I would like to add context that I believe is relevant for the classification.
This scenario represented an open behavioral point in the API — one where the expected response was not unambiguously settled across implementations. The whitepaper resolved that ambiguity through an alignment process across operators. PR #106 carries that agreed clarification into the YAML.
In that framing, this is a clarification of previously underspecified behavior, not the introduction of a new behavioral constraint that breaks existing consumers. The distinction matters for CHANGELOG purposes: a breaking change signals to consumers that something that worked against v0.2.0 will fail against v0.3.0. That is not the situation here — what changed is that an open question now has a definitive answer.
|
@camaraproject/number-recycling_maintainers, @camaraproject/number-recycling_codeowners |
|
@eric-murray, thank you for your suggestion. Please let me delete |
Release Review: r3.1 rc
This PR finalizes the reviewable release content for the active snapshot.
Edit and review this PR before merging it into the release snapshot. After Codeowner and Release Management approval, merging this PR creates the draft release.
Release contents
0.3.0-rc.10.2.0Dependencies: Commonalities r4.3, ICM r4.2
Codeowner Actions
Tick each box once done. Release Management review starts when all three boxes are ticked.
Update the CHANGELOG
What to do:
Document deferred validation warnings (and hints)
What to do:
The release is ready for Release Management review
Check that:
Tick this box to confirm readiness and to start the Release Management review.
Release Management Actions
Required release assets per API status
public
public
M = Mandatory, O = Optional — Full documentation
Valid next actions for codeowners
/discard-snapshot <reason>in the Release Issue to discard this snapshot, return toplanned, and update content onmainSnapshot:
r3.1-e8e9094