Skip to content

Commit 6efede5

Browse files
committed
Add comments for service selector enums
Signed-off-by: Hayden B <8418760+haydentherapper@users.noreply.github.com>
1 parent da14d87 commit 6efede5

File tree

9 files changed

+70
-11
lines changed

9 files changed

+70
-11
lines changed

gen/jsonschema/schemas/ClientTrustConfig.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@
218218
],
219219
"type": "string",
220220
"title": "Service Selector",
221-
"description": "ServiceSelector specifies how a client should select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
221+
"description": "ServiceSelector specifies how a client SHOULD select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
222222
},
223223
"count": {
224224
"type": "integer",

gen/jsonschema/schemas/ServiceConfiguration.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
],
1414
"type": "string",
1515
"title": "Service Selector",
16-
"description": "ServiceSelector specifies how a client should select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
16+
"description": "ServiceSelector specifies how a client SHOULD select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
1717
},
1818
"count": {
1919
"type": "integer",

gen/jsonschema/schemas/SigningConfig.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
],
112112
"type": "string",
113113
"title": "Service Selector",
114-
"description": "ServiceSelector specifies how a client should select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
114+
"description": "ServiceSelector specifies how a client SHOULD select a set of Services to connect to. A client SHOULD throw an error if the value is SERVICE_SELECTOR_UNDEFINED."
115115
},
116116
"count": {
117117
"type": "integer",

gen/pb-go/trustroot/v1/sigstore_trustroot.pb.go

Lines changed: 13 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/pb-python/sigstore_protobuf_specs/dev/sigstore/trustroot/v1/__init__.py

Lines changed: 18 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/pb-rust/sigstore-protobuf-specs/src/generated/dev.sigstore.trustroot.v1.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ pub struct ClientTrustConfig {
315315
#[prost(message, optional, tag = "3")]
316316
pub signing_config: ::core::option::Option<SigningConfig>,
317317
}
318-
/// ServiceSelector specifies how a client should select a set of
318+
/// ServiceSelector specifies how a client SHOULD select a set of
319319
/// Services to connect to. A client SHOULD throw an error if
320320
/// the value is SERVICE_SELECTOR_UNDEFINED.
321321
#[derive(
@@ -326,8 +326,17 @@ pub struct ClientTrustConfig {
326326
#[repr(i32)]
327327
pub enum ServiceSelector {
328328
Undefined = 0,
329+
/// Clients SHOULD select all Services based on supported API version
330+
/// and validity window.
329331
All = 1,
332+
/// Clients SHOULD select one Service based on supported API version
333+
/// and validity window. It is up to the client implementation to
334+
/// decide how to select the Service, e.g. random or round-robin.
330335
Any = 2,
336+
/// Clients SHOULD select a specific number of Services based on
337+
/// supported API version and validity window, using the provided
338+
/// `count`. It is up to the client implementation to decide how to
339+
/// select the Service, e.g. random or round-robin.
331340
Exact = 3,
332341
}
333342
impl ServiceSelector {
Binary file not shown.

gen/pb-typescript/src/__generated__/sigstore_trustroot.ts

Lines changed: 16 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

protos/sigstore_trustroot.proto

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,13 +248,22 @@ message Service {
248248
dev.sigstore.common.v1.TimeRange valid_for = 3;
249249
}
250250

251-
// ServiceSelector specifies how a client should select a set of
251+
// ServiceSelector specifies how a client SHOULD select a set of
252252
// Services to connect to. A client SHOULD throw an error if
253253
// the value is SERVICE_SELECTOR_UNDEFINED.
254254
enum ServiceSelector {
255255
SERVICE_SELECTOR_UNDEFINED = 0;
256+
// Clients SHOULD select all Services based on supported API version
257+
// and validity window.
256258
ALL = 1;
259+
// Clients SHOULD select one Service based on supported API version
260+
// and validity window. It is up to the client implementation to
261+
// decide how to select the Service, e.g. random or round-robin.
257262
ANY = 2;
263+
// Clients SHOULD select a specific number of Services based on
264+
// supported API version and validity window, using the provided
265+
// `count`. It is up to the client implementation to decide how to
266+
// select the Service, e.g. random or round-robin.
258267
EXACT = 3;
259268
}
260269

0 commit comments

Comments
 (0)