update API descriptions

This commit is contained in:
Sebastian Thiel
2020-07-10 09:11:32 +08:00
parent b6ee34dcff
commit 69fb05c4e1
271 changed files with 82506 additions and 23249 deletions

View File

@@ -40,11 +40,6 @@
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -76,11 +71,6 @@
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
@@ -194,12 +184,12 @@
],
"parameters": {
"instanceId": {
"description": "The name of the instance to create.\nThe name must be unique for the specified project and location.",
"description": "Required. The ID of the instance to create.\nThe ID must be unique within the specified project and location.\n\nThis value must start with a lowercase letter followed by up to 62\nlowercase letters, numbers, or hyphens, and cannot end with a hyphen.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The instance's project and location, in the format\nprojects/{project_id}/locations/{location}. In Cloud Filestore,\nlocations map to GCP zones, for example **us-west1-b**.",
"description": "Required. The instance's project and location, in the format\nprojects/{project_id}/locations/{location}. In Cloud Filestore,\nlocations map to GCP zones, for example **us-west1-b**.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -227,7 +217,7 @@
],
"parameters": {
"name": {
"description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}",
"description": "Required. The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
@@ -252,7 +242,7 @@
],
"parameters": {
"name": {
"description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}.",
"description": "Required. The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
@@ -298,7 +288,7 @@
"type": "string"
},
"parent": {
"description": "The project and location for which to retrieve instance information,\nin the format projects/{project_id}/locations/{location}. In Cloud\nFilestore, locations map to GCP zones, for example **us-west1-b**. To\nretrieve instance information for all locations, use \"-\" for the {location}\nvalue.",
"description": "Required. The project and location for which to retrieve instance information,\nin the format projects/{project_id}/locations/{location}. In Cloud\nFilestore, locations map to GCP zones, for example **us-west1-b**. To\nretrieve instance information for all locations, use \"-\" for the {location}\nvalue.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -330,7 +320,7 @@
"type": "string"
},
"updateMask": {
"description": "Mask of fields to update. At least one path must be supplied in this\nfield. The elements of the repeated paths field may only include these\nfields:\n\n* \"description\"\n* \"file_shares\"\n* \"labels\"",
"description": "Required. Mask of fields to update. At least one path must be supplied in this\nfield. The elements of the repeated paths field may only include these\nfields:\n\n* \"description\"\n* \"file_shares\"\n* \"labels\"",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -477,7 +467,7 @@
}
}
},
"revision": "20200406",
"revision": "20200613",
"rootUrl": "https://file.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
@@ -504,6 +494,13 @@
"name": {
"description": "The name of the file share (must be 16 characters or less).",
"type": "string"
},
"nfsExportOptions": {
"description": "Nfs Export Options.\nThere is a limit of 10 export options per file share.",
"items": {
"$ref": "NfsExportOptions"
},
"type": "array"
}
},
"type": "object"
@@ -541,6 +538,10 @@
"description": "The MaintenanceSchedule contains the scheduling information of published\nmaintenance schedule.",
"type": "object"
},
"maintenanceSettings": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings",
"description": "Optional. The MaintenanceSettings associated with instance."
},
"name": {
"description": "Unique name of the resource. It uses the form:\n `projects/{project_id}/locations/{location_id}/instances/{instance_id}`",
"type": "string"
@@ -633,6 +634,17 @@
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings": {
"description": "Maintenance settings associated with instance. Allows service producers and\nend users to assign settings that controls maintenance on this instance.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings",
"properties": {
"exclude": {
"description": "Optional. Exclude instance from maintenance. When true, rollout service will not\nattempt maintenance on the instance. Rollout service will include the\ninstance in reported rollout progress as not attempted.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata": {
"description": "Node information for custom per-node SLO implementations.\nSSA does not support per-node SLO, but producers can populate per-node\ninformation in SloMetadata for custom precomputations.\nSSA Eligibility Exporter will emit per-node metric based on this information.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata",
@@ -749,7 +761,7 @@
"type": "string"
},
"description": {
"description": "Optional. The description of the instance (2048 characters or less).",
"description": "The description of the instance (2048 characters or less).",
"type": "string"
},
"etag": {
@@ -789,7 +801,8 @@
"READY",
"REPAIRING",
"DELETING",
"ERROR"
"ERROR",
"RESTORING"
],
"enumDescriptions": [
"State not set.",
@@ -797,7 +810,8 @@
"The instance is available for use.",
"Work is being done on the instance. You can get further details from the\n`statusMessage` field of the `Instance` resource.",
"The instance is shutting down.",
"The instance is experiencing an issue and might be unusable. You can get\nfurther details from the `statusMessage` field of the `Instance`\nresource."
"The instance is experiencing an issue and might be unusable. You can get\nfurther details from the `statusMessage` field of the `Instance`\nresource.",
"The instance is restoring a snapshot or backup to an existing file share\nand may be unusable during this time."
],
"type": "string"
},
@@ -960,6 +974,58 @@
},
"type": "object"
},
"NfsExportOptions": {
"description": "NFS export options specifications.",
"id": "NfsExportOptions",
"properties": {
"accessMode": {
"description": "Either READ_ONLY, for allowing only read requests on the exported\ndirectory, or READ_WRITE, for allowing both read and write requests.\nThe default is READ_WRITE.",
"enum": [
"ACCESS_MODE_UNSPECIFIED",
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"AccessMode not set.",
"The client can only read the file share.",
"The client can read and write the file share (default)."
],
"type": "string"
},
"anonGid": {
"description": "An integer representing the anonymous group id with a default value of\n65534.\nAnon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be\nreturned if this field is specified for other squash_mode settings.",
"format": "int64",
"type": "string"
},
"anonUid": {
"description": "An integer representing the anonymous user id with a default value of\n65534.\nAnon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be\nreturned if this field is specified for other squash_mode settings.",
"format": "int64",
"type": "string"
},
"ipRanges": {
"description": "List of either an IPv4 addresses in the format\n{octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format\n{octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the\nfile share.\nOverlapping IP ranges are not allowed, both within and across\nNfsExportOptions. An error will be returned.\nThe limit is 64 IP ranges/addresses for each FileShareConfig among all\nNfsExportOptions.",
"items": {
"type": "string"
},
"type": "array"
},
"squashMode": {
"description": "Either NO_ROOT_SQUASH, for allowing root access on the exported directory,\nor ROOT_SQUASH, for not allowing root access. The default is\nNO_ROOT_SQUASH.",
"enum": [
"SQUASH_MODE_UNSPECIFIED",
"NO_ROOT_SQUASH",
"ROOT_SQUASH"
],
"enumDescriptions": [
"SquashMode not set.",
"The Root user has root access to the file share (default).",
"The Root user has squashed access to the anonymous uid/gid."
],
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",