Skip to main content

apidocs

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

Overview​

Nameapidocs
TypeResource
Idgoogle.apigee.apidocs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
dataobjectApiDoc represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The api_product_name field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. (id: GoogleCloudApigeeV1ApiDoc)
errorCodestringUnique error code for the request, if any.
messagestringDescription of the operation.
requestIdstringUnique ID of the request.
statusstringStatus of the operation.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_sites_apidocs_getselectorganizationsId, sitesId, apidocsIdGets a catalog item.
organizations_sites_apidocs_listselectorganizationsId, sitesIdpageToken, pageSizeReturns the catalog items associated with a portal.
organizations_sites_apidocs_createinsertorganizationsId, sitesIdCreates a new catalog item.
organizations_sites_apidocs_updatereplaceorganizationsId, sitesId, apidocsIdUpdates a catalog item.
organizations_sites_apidocs_deletedeleteorganizationsId, sitesId, apidocsIdDeletes a catalog item.

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.

NameDatatypeDescription
apidocsIdstring
organizationsIdstring
sitesIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Gets a catalog item.

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

INSERT examples​

Creates a new catalog item.

INSERT INTO google.apigee.apidocs (
data__edgeAPIProductName,
data__graphqlSchema,
data__imageUrl,
data__categoryIds,
data__graphqlSchemaDisplayName,
data__visibility,
data__requireCallbackUrl,
data__published,
data__anonAllowed,
data__apiProductName,
data__specId,
data__graphqlEndpointUrl,
data__description,
data__title,
organizationsId,
sitesId
)
SELECT 
'{{ edgeAPIProductName }}',
'{{ graphqlSchema }}',
'{{ imageUrl }}',
'{{ categoryIds }}',
'{{ graphqlSchemaDisplayName }}',
{{ visibility }},
{{ requireCallbackUrl }},
{{ published }},
{{ anonAllowed }},
'{{ apiProductName }}',
'{{ specId }}',
'{{ graphqlEndpointUrl }}',
'{{ description }}',
'{{ title }}',
'{{ organizationsId }}',
'{{ sitesId }}'
RETURNING
data,
errorCode,
message,
requestId,
status
;

REPLACE examples​

Updates a catalog item.

REPLACE google.apigee.apidocs
SET 
data__edgeAPIProductName = '{{ edgeAPIProductName }}',
data__graphqlSchema = '{{ graphqlSchema }}',
data__imageUrl = '{{ imageUrl }}',
data__categoryIds = '{{ categoryIds }}',
data__graphqlSchemaDisplayName = '{{ graphqlSchemaDisplayName }}',
data__visibility = {{ visibility }},
data__requireCallbackUrl = {{ requireCallbackUrl }},
data__published = {{ published }},
data__anonAllowed = {{ anonAllowed }},
data__apiProductName = '{{ apiProductName }}',
data__specId = '{{ specId }}',
data__graphqlEndpointUrl = '{{ graphqlEndpointUrl }}',
data__description = '{{ description }}',
data__title = '{{ title }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND apidocsId = '{{ apidocsId }}' --required
RETURNING
data,
errorCode,
message,
requestId,
status;

DELETE examples​

Deletes a catalog item.

DELETE FROM google.apigee.apidocs
WHERE organizationsId = '{{ organizationsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND apidocsId = '{{ apidocsId }}' --required
;