Skip to content

Commit 0b22560

Browse files
authored
Clarify node deprecation intent (#1266)
* Clarify node deprecation intent
1 parent 7480d11 commit 0b22560

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/releases.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,20 @@ As a side note, these releases are compatible with the notion of
7171

7272
6. Wherever possible, it is RECOMMENDED to make backward compatible API changes
7373
(e.g. deprecating leaves via the
74-
[status statement](https://www.rfc-editor.org/rfc/rfc7950#section-7.21.2))
74+
[status statement](https://datatracker.ietf.org/doc/html/rfc6020#section-7.19.2))
7575
for at least one minor release prior to a non-backward compatible API change
7676
in order to ease the transition to the new API. These leaves are then
7777
expected to be removed or modified in the next major version release. NOTE:
7878
This guideline may change once OpenConfig operators gain more experience
7979
managing breaking changes.
8080

81-
7. Release documentation should include the list of models and their version
81+
7. [Deprecated](https://datatracker.ietf.org/doc/html/rfc6020#section-7.19.2)
82+
nodes must be supported until they are deleted from the models. The deprecated
83+
status serves as a hint that the node will be removed in some future release of
84+
OpenConfig data models and operators are advised to stop using the node. The
85+
node description will recommend an alternative node or action.
86+
87+
8. Release documentation should include the list of models and their version
8288
numbers contained in the corresponding release.
8389

8490
Each release `vx.y.z` (e.g. `v1.2.0`) MAY be given a name for easier human

0 commit comments

Comments
 (0)