Skip to content

Add clarification as to error handling with gNMI extensions. #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robshakir wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add clarification as to error handling with gNMI extensions. #223

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
236093c
Add clarification as to error handling with gNMI extensions.
robshakir Apr 7, 2025
0593dd3
Update version of gnmi-extensions spec.
robshakir Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions rpc/gnmi/gnmi-extensions.md
View file
Open in desktop
Copy link
Member

@dplore dplore Apr 7, 2025

Choose a reason for hiding this comment

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

Content LGTM.

Also update the revision date and version?

Should we also update to the gnmi spec and gnmi_ext.proto?

Copy link
Member Author

@robshakir robshakir Apr 8, 2025

Choose a reason for hiding this comment

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

Updated revision date + version.

What do you propose we update in the gNMI spec + proto? Part of the reasons for the modularity of specs we have is to prevent there being a single doc that is somewhat unmaintainable.

Copy link
Member Author

@robshakir robshakir Apr 15, 2025

Choose a reason for hiding this comment

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

@dplore friendly ping.

Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
**Contributors**: Rob Shakir (robjs@google.com), Carl Lebsack (csl@google.com),
Nick Ethier (nethier@jive.com), Anees Shaikh (aashaikh@google.com)

**Updated**: January 25th, 2018
**Updated**: April 7, 2025

**Version**: 0.1.0
**Version**: 0.2.0

## Extending gNMI

Expand Down Expand Up @@ -70,3 +70,14 @@ The `Extension` message consists of a single `oneof` which may contain:
registered extension.
* A `bytes` field which stores the binary-marshalled protobuf for the
extension.

## Error handling

New extensions may be added by a client that are unknown to a server, and
vice versa. For this reason, unknown extensions being present in a message
capable of carrying extensions MUST NOT be treated as an error.

In the case that a known extension is received within an RPC the receiving
entity (client or server) and that extension contains invalid contents
(based on syntax of semantics) then the receiver MAY treat this as an error,
and MAY choose to terminate the corresponding RPC.