apidocs

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

Overview

Name	apidocs
Type	Resource
Id	google.apigee.apidocs

Fields

Name	Datatype	Description
data	object	ApiDoc 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.
errorCode	string	Unique error code for the request, if any.
message	string	Description of the operation.
requestId	string	Unique ID of the request.
status	string	Status of the operation.

Methods

Name	Accessible by	Required Params	Description
organizations_sites_apidocs_get	SELECT	apidocsId, organizationsId, sitesId	Gets a catalog item.
organizations_sites_apidocs_list	SELECT	organizationsId, sitesId	Returns the catalog items associated with a portal.
organizations_sites_apidocs_create	INSERT	organizationsId, sitesId	Creates a new catalog item.
organizations_sites_apidocs_delete	DELETE	apidocsId, organizationsId, sitesId	Deletes a catalog item.
organizations_sites_apidocs_update	REPLACE	apidocsId, organizationsId, sitesId	Updates a catalog item.

SELECT examples

Returns the catalog items associated with a portal.

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

INSERT example

Use the following StackQL query and manifest file to create a new apidocs resource.

All Properties

/*+ create */
INSERT INTO google.apigee.apidocs (
organizationsId,
sitesId,
apiProductName,
graphqlSchema,
anonAllowed,
description,
edgeAPIProductName,
published,
visibility,
title,
requireCallbackUrl,
categoryIds,
imageUrl,
specId,
graphqlSchemaDisplayName,
graphqlEndpointUrl
)
SELECT 
'{{ organizationsId }}',
'{{ sitesId }}',
'{{ apiProductName }}',
'{{ graphqlSchema }}',
{{ anonAllowed }},
'{{ description }}',
'{{ edgeAPIProductName }}',
{{ published }},
{{ visibility }},
'{{ title }}',
{{ requireCallbackUrl }},
'{{ categoryIds }}',
'{{ imageUrl }}',
'{{ specId }}',
'{{ graphqlSchemaDisplayName }}',
'{{ graphqlEndpointUrl }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: apiProductName
      value: string
    - name: graphqlSchema
      value: string
    - name: modified
      value: string
    - name: anonAllowed
      value: boolean
    - name: id
      value: string
    - name: description
      value: string
    - name: edgeAPIProductName
      value: string
    - name: published
      value: boolean
    - name: visibility
      value: boolean
    - name: title
      value: string
    - name: requireCallbackUrl
      value: boolean
    - name: categoryIds
      value:
        - string
    - name: imageUrl
      value: string
    - name: siteId
      value: string
    - name: specId
      value: string
    - name: graphqlSchemaDisplayName
      value: string
    - name: graphqlEndpointUrl
      value: string

REPLACE example

Replaces all fields in the specified apidocs resource.

/*+ update */
REPLACE google.apigee.apidocs
SET 
apiProductName = '{{ apiProductName }}',
graphqlSchema = '{{ graphqlSchema }}',
anonAllowed = true|false,
description = '{{ description }}',
edgeAPIProductName = '{{ edgeAPIProductName }}',
published = true|false,
visibility = true|false,
title = '{{ title }}',
requireCallbackUrl = true|false,
categoryIds = '{{ categoryIds }}',
imageUrl = '{{ imageUrl }}',
specId = '{{ specId }}',
graphqlSchemaDisplayName = '{{ graphqlSchemaDisplayName }}',
graphqlEndpointUrl = '{{ graphqlEndpointUrl }}'
WHERE 
apidocsId = '{{ apidocsId }}'
AND organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';

DELETE example

Deletes the specified apidocs resource.

/*+ delete */
DELETE FROM google.apigee.apidocs
WHERE apidocsId = '{{ apidocsId }}'
AND organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';