Skip to content

add atomic flag parsing semantics#237

Merged
ElodinLaarz merged 3 commits intomasterfrom
atomic-spec
Mar 31, 2026
Merged

add atomic flag parsing semantics#237
ElodinLaarz merged 3 commits intomasterfrom
atomic-spec

Conversation

@ElodinLaarz
Copy link
Copy Markdown
Contributor

@ElodinLaarz ElodinLaarz commented Mar 5, 2026

Explain how the atomic flag works and interacts with oc-ext:atomic extension.

Copilot Summary:

This pull request updates the gnmi-specification.md to clarify and formalize the parsing and behavioral semantics of atomic notifications in the gNMI protocol. The most significant changes include a new section detailing how to parse atomic notifications, guidance for both clients and devices on handling atomic containers in subscriptions, and an update to the revision history to document these changes.

Atomic Notification Parsing and Behavior:

  • Added a new section, "Parsing Atomic gNMI Notifications," which details how the atomic flag in a Notification message should be interpreted, emphasizing schema-independence, implicit deletion of prior state, invalidation rules, and the importance of prefix scope.
  • Clarified that the atomic field in the Notification message indicates an atomic update, and explained how atomic and non-atomic notifications affect the validity of cached state for a given prefix.

Atomic Containers in Subscriptions and Requests:

  • Added a section on "Atomic Containers in Subscribe and Get Requests," explaining how devices should generate atomic notifications when clients subscribe to only a subset of leaves within an atomic container, and how clients should interpret such notifications.

Documentation and Navigation Updates:

  • Updated the table of contents to include new sections for parsing atomic notifications and atomic containers in subscriptions/requests. [1] [2]
  • Updated the revision history to version 0.11.0, documenting the new definitions for parsing semantics of the atomic flag.

Copy link
Copy Markdown

@romeyod romeyod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we add some guidance about how atomic containers should ideally not have frequently changing leafs/containers like counters?

@ElodinLaarz
Copy link
Copy Markdown
Contributor Author

should we add some guidance about how atomic containers should ideally not have frequently changing leafs/containers like counters?

Added a comment on best practices and frequently changing leaves.

@ElodinLaarz ElodinLaarz requested a review from dplore March 11, 2026 22:44
Copy link
Copy Markdown
Member

@dplore dplore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed in March 17, 2026 OC Operators meeting without objection. Setting last call to March 31, 2026

@dplore dplore moved this from Ready to discuss to last-call in OC Operator Review Mar 17, 2026
@dplore dplore linked an issue Mar 17, 2026 that may be closed by this pull request
@ElodinLaarz ElodinLaarz merged commit 1b27383 into master Mar 31, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: last-call

Development

Successfully merging this pull request may close these issues.

YANG Atomic extensions and behavioral expectations

3 participants