Apigee API (apigee:v1)

Additions

Methods


• ▼ ▲ apigee.organizations.sites.apidocs.updateDocumentation

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

  HTTP Method: PATCH

  Path: v1/{+name}

  Parameter Order: name

  Parameters:

  name

  Description: Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`

  Type: string

  Location: path

  Pattern: ^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+/documentation$

  Required: Yes

  Description: Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation

• ▼ ▲ apigee.organizations.sites.apidocs.create

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

  Path: v1/{+parent}/apidocs

  Parameters:

  parent

  Description: Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

  Required: Yes

  Type: string

  Pattern: ^organizations/[^/]+/sites/[^/]+$

  Location: path

  Description: Creates a new catalog item.

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs

  Parameter Order: parent

  HTTP Method: POST

• ▼ ▲ apigee.organizations.sites.apidocs.update

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

  Parameters:

  name

  Required: Yes

  Pattern: ^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$

  Location: path

  Description: Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

  Type: string

  Description: Updates a catalog item.

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}

  HTTP Method: PUT

  Parameter Order: name

  Path: v1/{+name}

• ▼ ▲ apigee.organizations.sites.apidocs.get

  Parameters:

  name

  Type: string

  Description: Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

  Pattern: ^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$

  Required: Yes

  Location: path

  Path: v1/{+name}

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

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}

  Parameter Order: name

  Description: Gets a catalog item.

  HTTP Method: GET

• ▼ ▲ apigee.organizations.sites.apidocs.getDocumentation

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

  Path: v1/{+name}

  Description: Gets the documentation for the specified catalog item.

  Parameters:

  name

  Required: Yes

  Pattern: ^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+/documentation$

  Description: Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`

  Type: string

  Location: path

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation

  HTTP Method: GET

  Parameter Order: name

• ▼ ▲ apigee.organizations.sites.apidocs.delete

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}

  Description: Deletes a catalog item.

  Parameter Order: name

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

  Path: v1/{+name}

  HTTP Method: DELETE

  Parameters:

  name

  Description: Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

  Required: Yes

  Pattern: ^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$

  Location: path

  Type: string

• ▼ ▲ apigee.organizations.sites.apidocs.list

  Parameter Order: parent

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

  Description: Returns the catalog items associated with a portal.

  Parameters:

  parent

  Location: path

  Description: Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

  Type: string

  Pattern: ^organizations/[^/]+/sites/[^/]+$

  Required: Yes

  pageSize

  Format: int32

  Description: Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  Location: query

  Type: integer

  pageToken

  Description: Optional. A page token, received from a previous `ListApiDocs` call. Provide this to retrieve the subsequent page.

  Location: query

  Type: string

  Flat Path: v1/organizations/{organizationsId}/sites/{sitesId}/apidocs

  HTTP Method: GET

  Path: v1/{+parent}/apidocs