v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13214471.4 KB
projects

Creates a new Schema in a given project and location. Only creation of schemas/main is supported and calling create with any other schema ID will result in an error.

post/v1/{+parent}/schemas

Path parameters

parentstring required

Required. Value for parent.

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

schemaIdstring

Required. The ID to use for the schema, which will become the final component of the schema's resource name. Currently, only main is supported and any other schema ID will result in an error.

validateOnlyboolean

Optional. If set, validate the request and preview the Schema, but do not actually update it.

Request body

createTimestring google-datetime

Output only. [Output only] Create time stamp.

uidstring

Output only. System-assigned, unique identifier.

namestring

Identifier. The relative resource name of the schema, in the format: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Right now, the only supported schema is "main".

labelsobject

Optional. Labels as key value pairs.

etagstring

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154

annotationsobject

Optional. Stores small amounts of arbitrary data.

updateTimestring google-datetime

Output only. [Output only] Update time stamp.

reconcilingboolean

Output only. A field that if true, indicates that the system is working to compile and deploy the schema.

displayNamestring

Optional. Mutable human-readable name. 63 character limit.

Response

Successful response