Method: projects.locations.generateOpenApiSpec

Generate OpenAPI spec for the requested integrations and api triggers

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*}:generateOpenApiSpec

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Project and location from which the integrations should be fetched. Format: projects/{project}/location/{location}

Request body

The request body contains data with the following structure:

JSON representation
{
  "apiTriggerResources": [
    {
      object (ApiTriggerResource)
    }
  ],
  "fileFormat": enum (FileFormat)
}
Fields
apiTriggerResources[]

object (ApiTriggerResource)

Required. List of api triggers

fileFormat

enum (FileFormat)

Required. File format for generated spec.

Response body

Response of the locations.generateOpenApiSpec API.

If successful, the response body contains data with the following structure:

JSON representation
{
  "openApiSpec": string
}
Fields
openApiSpec

string

Open API spec as per the required format

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.integrations.generateOpenApiSpec

For more information, see the IAM documentation.

ApiTriggerResource

List of API triggerID and their workflow resource name.

JSON representation
{
  "integrationResource": string,
  "triggerId": [
    string
  ]
}
Fields
integrationResource

string

Required. Integration where the API is published

triggerId[]

string

Required. Trigger id of the API trigger(s) in the integration