Skip to content

Commit

Permalink
confdgnmi - updated doc (formatting), typo in workflow
Browse files Browse the repository at this point in the history
Signed-off-by: Michal Novak <[email protected]>
  • Loading branch information
micnovak committed May 12, 2021
1 parent 4683069 commit 72d00d9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/confdgnmi.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Confd gNMI Apdaper
name: Confd gNMI Adapter

on:
push:
Expand Down
6 changes: 3 additions & 3 deletions confdgnmi/docs/ConfD_gNMI_adapter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ NOTE: In `gnmi.proto` we have updated `import "gnmi_ext.proto"`

== gNMI overview

gNMI protocol consists of four operations (`Capabilities`, Set`, `Get` and `Subscribe`).
gNMI protocol consists of four operations/messages (`Capabilities`, `Set`, `Get` and `Subscribe`).

.gNMI Interface
[source, protobuf, role="acopy"]
Expand All @@ -180,7 +180,7 @@ service gNMI {
}
----

NOTE: The interface itself looks relatively simple, but we need to consider the Request and Response messages are complex. Mainly `Subscribe` method has many variants. More details can be found in the https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification[gNMI Specification].
NOTE: The interface itself looks relatively simple, but the `Request` and `Response` messages may be complex. `Subscribe` method has many variants. More details can be found in the https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification[gNMI Specification].

== Building gNMI Adapter demo

Expand Down Expand Up @@ -892,7 +892,7 @@ This not all gNMI functionality are currently supported. They may be added in th
*Limitations*

* only `BYTES` are used as `encoding`
* `Get`, `Set` and `Subscribe` works only on `the leaf`, `list` entries and `lists`
* `Get`, `Set` and `Subscribe` works only on the `leaf`, `list` entries and `lists`
* `Set` works only on `leaf` elements
* `Subscribe`
** not all subscription parameters are supported
Expand Down

0 comments on commit 72d00d9

Please sign in to comment.