apidocs_documentation

Creates, updates, deletes, gets or lists an apidocs_documentation resource.

Overview

Name	apidocs_documentation
Type	Resource
Id	google.apigee.apidocs_documentation

Fields

The following fields are returned by SELECT queries:

organizations_sites_apidocs_get_documentation

Successful response

Name	Datatype	Description
data	object	Output only. The documentation resource. (id: GoogleCloudApigeeV1ApiDocDocumentation)
errorCode	string	Output only. Unique error code for the request, if any.
message	string	Output only. Description of the operation.
requestId	string	Output only. Unique ID of the request.
status	string	Output only. Status of the operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_sites_apidocs_get_documentation	select	organizationsId, sitesId, apidocsId		Gets the documentation for the specified catalog item.
organizations_sites_apidocs_update_documentation	update	organizationsId, sitesId, apidocsId		Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apidocsId	string
organizationsId	string
sitesId	string

SELECT examples

organizations_sites_apidocs_get_documentation

Gets the documentation for the specified catalog item.

SELECT
data,
errorCode,
message,
requestId,
status
FROM google.apigee.apidocs_documentation
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sitesId = '{{ sitesId }}' -- required
AND apidocsId = '{{ apidocsId }}' -- required;

UPDATE examples

organizations_sites_apidocs_update_documentation

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

UPDATE google.apigee.apidocs_documentation
SET 
data__oasDocumentation = '{{ oasDocumentation }}',
data__graphqlDocumentation = '{{ graphqlDocumentation }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND apidocsId = '{{ apidocsId }}' --required
RETURNING
data,
errorCode,
message,
requestId,
status;