Clarified the intent of the uri field in the certificate authority (#140

) * Clarified the intent of the uri field in the certificate authority Signed-off-by: Fredrik Skogman <[email protected]> * Fixed spelling Signed-off-by: Fredrik Skogman <[email protected]> * Generate files based on the updated protobuf files. Signed-off-by: Fredrik Skogman <[email protected]> --------- Signed-off-by: Fredrik Skogman <[email protected]>
sigstore · Sep 18, 2023 · d382fc3 · d382fc3
1 parent c8b0b0f
commit d382fc3
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 10 deletions.
diff --git a/gen/jsonschema/schemas/CertificateAuthority.schema.json b/gen/jsonschema/schemas/CertificateAuthority.schema.json
@@ -11,7 +11,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/jsonschema/schemas/Input.schema.json b/gen/jsonschema/schemas/Input.schema.json
@@ -516,7 +516,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/jsonschema/schemas/TrustedRoot.schema.json b/gen/jsonschema/schemas/TrustedRoot.schema.json
@@ -179,7 +179,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/pb-go/trustroot/v1/sigstore_trustroot.pb.go b/gen/pb-go/trustroot/v1/sigstore_trustroot.pb.go
diff --git a/gen/pb-python/sigstore_protobuf_specs/dev/sigstore/trustroot/v1/__init__.py b/gen/pb-python/sigstore_protobuf_specs/dev/sigstore/trustroot/v1/__init__.py
diff --git a/gen/pb-rust/schemas/CertificateAuthority.schema.json b/gen/pb-rust/schemas/CertificateAuthority.schema.json
@@ -11,7 +11,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/pb-rust/schemas/Input.schema.json b/gen/pb-rust/schemas/Input.schema.json
@@ -516,7 +516,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/pb-rust/schemas/TrustedRoot.schema.json b/gen/pb-rust/schemas/TrustedRoot.schema.json
@@ -179,7 +179,7 @@
                 },
                 "uri": {
                     "type": "string",
-                    "description": "The URI at which the CA can be accessed."
+                    "description": "The URI identifies the certificate authority. It is RECOMMENDED that the URI is the base URL for the certificate authority, that can be provided to any SDK/client provided by the certificate authority to interact with the certificate authority."
                 },
                 "certChain": {
                     "$ref": "#/definitions/dev.sigstore.common.v1.X509CertificateChain",

diff --git a/gen/pb-typescript/src/__generated__/sigstore_trustroot.ts b/gen/pb-typescript/src/__generated__/sigstore_trustroot.ts
diff --git a/protos/sigstore_trustroot.proto b/protos/sigstore_trustroot.proto
@@ -47,7 +47,12 @@ message CertificateAuthority {
         // The root certificate MUST be self-signed, and so the subject and
         // issuer are the same.
         dev.sigstore.common.v1.DistinguishedName subject = 1;
-        // The URI at which the CA can be accessed.
+        // The URI identifies the certificate authority.
+        //
+        // It is RECOMMENDED that the URI is the base URL for the certificate
+        // authority, that can be provided to any SDK/client provided
+        // by the certificate authority to interact with the certificate
+        // authority.
         string uri = 2;
         // The certificate chain for this CA.
         dev.sigstore.common.v1.X509CertificateChain cert_chain = 3;