Skip to content

Add device_id field to capabilites request #556

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

Merged
chrispsommers merged 6 commits into from
May 9, 2025
Merged

Add device_id field to capabilites request #556

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
605a240
Add device_id field to capabilites request
verios-google Apr 29, 2025
490a478
Update generated proto code
verios-google Apr 29, 2025
9dd3aef
Add documentation on optional semantics of device_id
verios-google May 1, 2025
dffb3c5
Fixed whitespace
verios-google May 1, 2025
6b124ae
Address documentation comments and also tried making sure lines weren…
verios-google May 2, 2025
1a599a1
nit: Removed extra period
verios-google May 6, 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
17 changes: 13 additions & 4 deletions docs/v1/P4Runtime-Spec.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6030,10 +6030,19 @@ error {
== `Capabilities` RPC

The `Capabilities` RPC offers a mechanism through which a P4Runtime client can
discover the capabilities of the P4Runtime server implementation. At the moment,
the `CapabilitiesRequest` message is empty and the `CapabilitiesResponse`
message includes the `p4runtime_api_version` string field and the `experimental`
field, which has type `Any` Protobuf message cite:[ProtoAny].
discover the capabilities of the P4Runtime server implementation.

The `CapabilitiesRequest` message contains a single optional field `device_id`.

`device_id` is an optional filter to limit the capabilities in the response to those
applicable to the target P4 device. A `NOT_FOUND` error is returned if the `device_id`
is not recognized by the P4Runtime server. If `device_id` is unset (or 0), the response
should only include capabilities that are server-wide (those which are applicable
across all devices). Note that if `device_id` is set to a valid id, both server-wide and
device-specific capabilities will be returned.

The `CapabilitiesResponse` message includes the `p4runtime_api_version` string field
and the `experimental` field, which has type `Any` Protobuf message cite:[ProtoAny].

The `p4runtime_api_version` field must be set to the full semantic version string cite:[SemVer]
corresponding to the version of the P4Runtime API implemented by the server, e.g. "1.1.0-rc.1".
Expand Down
120 changes: 67 additions & 53 deletions go/p4/v1/p4runtime.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion proto/p4/v1/p4runtime.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -834,7 +834,12 @@ enum SdnPort {
}

//------------------------------------------------------------------------------
message CapabilitiesRequest {}
message CapabilitiesRequest {
// Optional: Response should include the device-specific capabilities of the
// device identified by `device_id` in addition to server-wide capabilities.
// Added in v1.5.0
uint64 device_id = 1;
}

message CapabilitiesResponse {
// The full semantic version string (e.g. "1.1.0-rc.1") corresponding to the
Expand Down
Loading