Sign in

v1

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

Create an API version for an API resource in the API hub.

post/v1/{+parent}/versions

Path parameters

parentstring required

Required. The parent resource for API version. Format: projects/{project}/locations/{location}/apis/{api}

Query parameters

versionIdstring

Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/.

Request body

displayNamestring

Required. The display name of the version.

specsstring[]

Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

apiOperationsstring[]

Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

selectedDeploymentstring

Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

definitionsstring[]

Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

createTimestring google-datetime

Output only. The time at which the version was created.

deploymentsstring[]

Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

updateTimestring google-datetime

Output only. The time at which the version was last updated.

namestring

Identifier. The name of the version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

attributesobject

Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

descriptionstring

Optional. The description of the version.

Response

Successful response