Skip to content

Add Any protobuf message to CapabilitiesResponse for experimental features #554

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
smolkaj merged 4 commits into from
Apr 17, 2025
Merged

Add Any protobuf message to CapabilitiesResponse for experimental features #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d231e81
Add `Any` protobuf message to CapabilitiesResponse for testing experi…
verios-google Apr 4, 2025
b81b6ad
Addressed comments to update documentation
verios-google Apr 11, 2025
4b954cb
Update documentation to address comments
verios-google Apr 17, 2025
9acc060
Update documentation to address comments
verios-google Apr 17, 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
13 changes: 10 additions & 3 deletions docs/v1/P4Runtime-Spec.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6032,9 +6032,16 @@ error {
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 only includes the `p4runtime_api_version` string field. This 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".
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".

The ` experimental` field is intended to allow parties to experiment with features
before proposing them for standardization. NOTE: This field will be deprecated after
`p4runtime.proto` is migrated from `proto3` to proto `editions`. Proto `extensions` cite:[ProtoExtension]
will be introduced as the standard way to support experimental use cases.

Future versions of P4Runtime may introduce more advanced capability discovery
features. For example, P4Runtime supports three xref:sec-batch-atomicity[atomicity
Expand Down
5 changes: 5 additions & 0 deletions docs/v1/resources/theme/references.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ @ONLINE { ProtoAny
url = "https://developers.google.com/protocol-buffers/docs/proto3#any"
}

@ONLINE { ProtoExtension,
title = "Protobuf extension feature",
url = "https://protobuf.dev/programming-guides/editions/#extensions"
}

@ONLINE { gRPCStatus,
title = "the gRPC $Status$ class",
url = "https://github.com/grpc/grpc/blob/master/include/grpcpp/impl/codegen/status.h"
Expand Down
143 changes: 79 additions & 64 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.

4 changes: 4 additions & 0 deletions proto/p4/v1/p4runtime.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,4 +840,8 @@ message CapabilitiesResponse {
// The full semantic version string (e.g. "1.1.0-rc.1") corresponding to the
// version of the P4Runtime API currently implemented by the server.
string p4runtime_api_version = 1;

// Used for experimental features before proposing them for standardization.
// Added in 1.5.0.
.google.protobuf.Any experimental = 999;
}
Loading