documentation_parts

Creates, updates, deletes or gets a documentation_part resource or lists documentation_parts in a region

Overview

Name	documentation_parts
Type	Resource
Description	The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Id	awscc.apigateway.documentation_parts

Fields

get (all properties)

Name	Datatype	Description
documentation_part_id	string
▶location	object	The &#96;&#96;Location&#96;&#96; property specifies the location of the Amazon API Gateway API entity that the documentation applies to. &#96;&#96;Location&#96;&#96; is a property of the &#91;AWS::ApiGateway::DocumentationPart&#93;(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.<br />For more information about each property, including constraints and valid values, see &#91;DocumentationPart&#93;(https://docs.aws.amazon.com/apigateway/latest/api/API&#95;DocumentationPartLocation.html) in the &#42;Amazon API Gateway REST API Reference&#42;.
properties	string
rest_api_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
documentation_part_id	string
rest_api_id	string
region	string	AWS region.

For more information, see AWS::ApiGateway::DocumentationPart.

Methods

Name	Resource	Accessible by	Required Params
create_resource	documentation_parts	INSERT	Location, Properties, RestApiId, region
delete_resource	documentation_parts	DELETE	Identifier, region
update_resource	documentation_parts	UPDATE	Identifier, PatchDocument, region
list_resources	documentation_parts_list_only	SELECT	region
get_resource	documentation_parts	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual documentation_part.

SELECT
  region,
  documentation_part_id,
  location,
  properties,
  rest_api_id
FROM awscc.apigateway.documentation_parts
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ documentation_part_id }}|{{ rest_api_id }}';

list (identifiers only)

Lists all documentation_parts in a region.

SELECT
  region,
  documentation_part_id,
  rest_api_id
FROM awscc.apigateway.documentation_parts_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new documentation_part resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_parts (
  Location,
  Properties,
  RestApiId,
  region
)
SELECT
  '{{ location }}',
  '{{ properties }}',
  '{{ rest_api_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_parts (
  Location,
  Properties,
  RestApiId,
  region
)
SELECT
  '{{ location }}',
  '{{ properties }}',
  '{{ rest_api_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: documentation_part
    props:
      - name: location
        value:
          method: '{{ method }}'
          name: '{{ name }}'
          path: '{{ path }}'
          status_code: '{{ status_code }}'
          type: '{{ type }}'
      - name: properties
        value: '{{ properties }}'
      - name: rest_api_id
        value: '{{ rest_api_id }}'

UPDATE example

Use the following StackQL query and manifest file to update a documentation_part resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigateway.documentation_parts
SET PatchDocument = string('{{ {
    "Properties": properties
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ documentation_part_id }}|{{ rest_api_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.documentation_parts
WHERE
  Identifier = '{{ documentation_part_id }}|{{ rest_api_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the documentation_parts resource, the following permissions are required:

Create

apigateway:GET,
apigateway:POST

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH

Delete

apigateway:DELETE

List

apigateway:GET