@devvit/protos 0.11.7 → 0.11.8-next-2025-02-10-c496a14e8.0

package/schema/.snootobuf/deps/google/api/apikeys/v2/apikeys.proto

@@ -0,0 +1,288 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api.apikeys.v2;
+
+import "google/api/annotations.proto";
+import "google/api/apikeys/v2/resources.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+
+option csharp_namespace = "Google.Cloud.ApiKeys.V2";
+option go_package = "cloud.google.com/go/apikeys/apiv2/apikeyspb;apikeyspb";
+option java_multiple_files = true;
+option java_outer_classname = "ApiKeysProto";
+option java_package = "com.google.api.apikeys.v2";
+option php_namespace = "Google\\Cloud\\ApiKeys\\V2";
+option ruby_package = "Google::Cloud::ApiKeys::V2";
+
+// Manages the API keys associated with projects.
+service ApiKeys {
+  option (google.api.default_host) = "apikeys.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform,"
+      "https://www.googleapis.com/auth/cloud-platform.read-only";
+
+  // Creates a new API key.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc CreateKey(CreateKeyRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v2/{parent=projects/*/locations/*}/keys"
+      body: "key"
+    };
+    option (google.api.method_signature) = "parent,key,key_id";
+    option (google.longrunning.operation_info) = {
+      response_type: "Key"
+      metadata_type: "google.protobuf.Empty"
+    };
+  }
+
+  // Lists the API keys owned by a project. The key string of the API key
+  // isn't included in the response.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc ListKeys(ListKeysRequest) returns (ListKeysResponse) {
+    option (google.api.http) = {
+      get: "/v2/{parent=projects/*/locations/*}/keys"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Gets the metadata for an API key. The key string of the API key
+  // isn't included in the response.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc GetKey(GetKeyRequest) returns (Key) {
+    option (google.api.http) = {
+      get: "/v2/{name=projects/*/locations/*/keys/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Get the key string for an API key.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc GetKeyString(GetKeyStringRequest) returns (GetKeyStringResponse) {
+    option (google.api.http) = {
+      get: "/v2/{name=projects/*/locations/*/keys/*}/keyString"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Patches the modifiable fields of an API key.
+  // The key string of the API key isn't included in the response.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc UpdateKey(UpdateKeyRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      patch: "/v2/{key.name=projects/*/locations/*/keys/*}"
+      body: "key"
+    };
+    option (google.api.method_signature) = "key,update_mask";
+    option (google.longrunning.operation_info) = {
+      response_type: "Key"
+      metadata_type: "google.protobuf.Empty"
+    };
+  }
+
+  // Deletes an API key. Deleted key can be retrieved within 30 days of
+  // deletion. Afterward, key will be purged from the project.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc DeleteKey(DeleteKeyRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v2/{name=projects/*/locations/*/keys/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "Key"
+      metadata_type: "google.protobuf.Empty"
+    };
+  }
+
+  // Undeletes an API key which was deleted within 30 days.
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  rpc UndeleteKey(UndeleteKeyRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v2/{name=projects/*/locations/*/keys/*}:undelete"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "Key"
+      metadata_type: "google.protobuf.Empty"
+    };
+  }
+
+  // Find the parent project and resource name of the API
+  // key that matches the key string in the request. If the API key has been
+  // purged, resource name will not be set.
+  // The service account must have the `apikeys.keys.lookup` permission
+  // on the parent project.
+  rpc LookupKey(LookupKeyRequest) returns (LookupKeyResponse) {
+    option (google.api.http) = {
+      get: "/v2/keys:lookupKey"
+    };
+  }
+}
+
+// Request message for `CreateKey` method.
+message CreateKeyRequest {
+  // Required. The project in which the API key is created.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "apikeys.googleapis.com/Key"
+    }
+  ];
+
+  // Required. The API key fields to set at creation time.
+  // You can configure only the `display_name`, `restrictions`, and
+  // `annotations` fields.
+  Key key = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // User specified key id (optional). If specified, it will become the final
+  // component of the key resource name.
+  //
+  // The id must be unique within the project, must conform with RFC-1034,
+  // is restricted to lower-cased letters, and has a maximum length of 63
+  // characters. In another word, the id must match the regular
+  // expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+  //
+  // The id must NOT be a UUID-like string.
+  string key_id = 3;
+}
+
+// Request message for `ListKeys` method.
+message ListKeysRequest {
+  // Required. Lists all API keys associated with this project.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "apikeys.googleapis.com/Key"
+    }
+  ];
+
+  // Optional. Specifies the maximum number of results to be returned at a time.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Requests a specific page of results.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Indicate that keys deleted in the past 30 days should also be
+  // returned.
+  bool show_deleted = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for `ListKeys` method.
+message ListKeysResponse {
+  // A list of API keys.
+  repeated Key keys = 1;
+
+  // The pagination token for the next page of results.
+  string next_page_token = 2;
+}
+
+// Request message for `GetKey` method.
+message GetKeyRequest {
+  // Required. The resource name of the API key to get.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "apikeys.googleapis.com/Key" }
+  ];
+}
+
+// Request message for `GetKeyString` method.
+message GetKeyStringRequest {
+  // Required. The resource name of the API key to be retrieved.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "apikeys.googleapis.com/Key" }
+  ];
+}
+
+// Response message for `GetKeyString` method.
+message GetKeyStringResponse {
+  // An encrypted and signed value of the key.
+  string key_string = 1;
+}
+
+// Request message for `UpdateKey` method.
+message UpdateKeyRequest {
+  // Required. Set the `name` field to the resource name of the API key to be
+  // updated. You can update only the `display_name`, `restrictions`, and
+  // `annotations` fields.
+  Key key = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // The field mask specifies which fields to be updated as part of this
+  // request. All other fields are ignored.
+  // Mutable fields are: `display_name`, `restrictions`, and `annotations`.
+  // If an update mask is not provided, the service treats it as an implied mask
+  // equivalent to all allowed fields that are set on the wire. If the field
+  // mask has a special value "*", the service treats it equivalent to replace
+  // all allowed mutable fields.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request message for `DeleteKey` method.
+message DeleteKeyRequest {
+  // Required. The resource name of the API key to be deleted.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "apikeys.googleapis.com/Key" }
+  ];
+
+  // Optional. The etag known to the client for the expected state of the key.
+  // This is to be used for optimistic concurrency.
+  string etag = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request message for `UndeleteKey` method.
+message UndeleteKeyRequest {
+  // Required. The resource name of the API key to be undeleted.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "apikeys.googleapis.com/Key" }
+  ];
+}
+
+// Request message for `LookupKey` method.
+message LookupKeyRequest {
+  // Required. Finds the project that owns the key string value.
+  string key_string = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for `LookupKey` method.
+message LookupKeyResponse {
+  // The project that owns the key with the value specified in the request.
+  string parent = 1;
+
+  // The resource name of the API key. If the API key has been purged,
+  // resource name is empty.
+  string name = 2;
+}

package/schema/.snootobuf/deps/google/api/apikeys/v2/resources.proto

@@ -0,0 +1,175 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api.apikeys.v2;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.ApiKeys.V2";
+option go_package = "cloud.google.com/go/apikeys/apiv2/apikeyspb;apikeyspb";
+option java_multiple_files = true;
+option java_outer_classname = "ResourcesProto";
+option java_package = "com.google.api.apikeys.v2";
+option php_namespace = "Google\\Cloud\\ApiKeys\\V2";
+option ruby_package = "Google::Cloud::ApiKeys::V2";
+
+// The representation of a key managed by the API Keys API.
+message Key {
+  option (google.api.resource) = {
+    type: "apikeys.googleapis.com/Key"
+    pattern: "projects/{project}/locations/{location}/keys/{key}"
+    plural: "keys"
+    singular: "key"
+    style: DECLARATIVE_FRIENDLY
+  };
+
+  // Output only. The resource name of the key.
+  // The `name` has the form:
+  // `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`.
+  // For example:
+  // `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2`
+  //
+  // NOTE: Key is a global resource; hence the only supported value for
+  // location is `global`.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Unique id in UUID4 format.
+  string uid = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Human-readable display name of this key that you can modify.
+  // The maximum length is 63 characters.
+  string display_name = 2;
+
+  // Output only. An encrypted and signed value held by this key.
+  // This field can be accessed only through the `GetKeyString` method.
+  string key_string = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. A timestamp identifying the time this key was originally
+  // created.
+  google.protobuf.Timestamp create_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. A timestamp identifying the time this key was last
+  // updated.
+  google.protobuf.Timestamp update_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. A timestamp when this key was deleted. If the resource is not
+  // deleted, this must be empty.
+  google.protobuf.Timestamp delete_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Annotations is an unstructured key-value map stored with a policy that
+  // may be set by external tools to store and retrieve arbitrary metadata.
+  // They are not queryable and should be preserved when modifying objects.
+  map<string, string> annotations = 8;
+
+  // Key restrictions.
+  Restrictions restrictions = 9;
+
+  // Output only. A checksum computed by the server based on the current value
+  // of the Key resource. This may be sent on update and delete requests to
+  // ensure the client has an up-to-date value before proceeding. See
+  // https://google.aip.dev/154.
+  string etag = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Describes the restrictions on the key.
+message Restrictions {
+  // The websites, IP addresses, Android apps, or iOS apps (the clients) that
+  // are allowed to use the key. You can specify only one type of client
+  // restrictions per key.
+  oneof client_restrictions {
+    // The HTTP referrers (websites) that are allowed to use the key.
+    BrowserKeyRestrictions browser_key_restrictions = 1;
+
+    // The IP addresses of callers that are allowed to use the key.
+    ServerKeyRestrictions server_key_restrictions = 2;
+
+    // The Android apps that are allowed to use the key.
+    AndroidKeyRestrictions android_key_restrictions = 3;
+
+    // The iOS apps that are allowed to use the key.
+    IosKeyRestrictions ios_key_restrictions = 4;
+  }
+
+  // A restriction for a specific service and optionally one or
+  // more specific methods. Requests are allowed if they
+  // match any of these restrictions. If no restrictions are
+  // specified, all targets are allowed.
+  repeated ApiTarget api_targets = 5;
+}
+
+// The HTTP referrers (websites) that are allowed to use the key.
+message BrowserKeyRestrictions {
+  // A list of regular expressions for the referrer URLs that are allowed
+  // to make API calls with this key.
+  repeated string allowed_referrers = 1;
+}
+
+// The IP addresses of callers that are allowed to use the key.
+message ServerKeyRestrictions {
+  // A list of the caller IP addresses that are allowed to make API calls
+  // with this key.
+  repeated string allowed_ips = 1;
+}
+
+// The Android apps that are allowed to use the key.
+message AndroidKeyRestrictions {
+  // A list of Android applications that are allowed to make API calls with
+  // this key.
+  repeated AndroidApplication allowed_applications = 1;
+}
+
+// Identifier of an Android application for key use.
+message AndroidApplication {
+  // The SHA1 fingerprint of the application. For example, both sha1 formats are
+  // acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or
+  // DA39A3EE5E6B4B0D3255BFEF95601890AFD80709.
+  // Output format is the latter.
+  string sha1_fingerprint = 1;
+
+  // The package name of the application.
+  string package_name = 2;
+}
+
+// The iOS apps that are allowed to use the key.
+message IosKeyRestrictions {
+  // A list of bundle IDs that are allowed when making API calls with this key.
+  repeated string allowed_bundle_ids = 1;
+}
+
+// A restriction for a specific service and optionally one or multiple
+// specific methods. Both fields are case insensitive.
+message ApiTarget {
+  // The service for this restriction. It should be the canonical
+  // service name, for example: `translate.googleapis.com`.
+  // You can use [`gcloud services list`](/sdk/gcloud/reference/services/list)
+  // to get a list of services that are enabled in the project.
+  string service = 1;
+
+  // Optional. List of one or more methods that can be called.
+  // If empty, all methods for the service are allowed. A wildcard
+  // (*) can be used as the last symbol.
+  // Valid examples:
+  //   `google.cloud.translate.v2.TranslateService.GetSupportedLanguage`
+  //   `TranslateText`
+  //   `Get*`
+  //   `translate.googleapis.com.Get*`
+  repeated string methods = 2 [(google.api.field_behavior) = OPTIONAL];
+}