apidocs_documentation

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

Overview

Name	apidocs_documentation
Type	Resource
Id	google.apigee.apidocs_documentation

Fields

Name	Datatype	Description
data	object	The documentation for a catalog item.
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

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

SELECT examples

Gets the documentation for the specified catalog item.

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

UPDATE example

Updates a apidocs_documentation resource.

/*+ update */
UPDATE google.apigee.apidocs_documentation
SET 
graphqlDocumentation = '{{ graphqlDocumentation }}',
oasDocumentation = '{{ oasDocumentation }}'
WHERE 
apidocsId = '{{ apidocsId }}'
AND organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';