documentation_versions

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

Overview

Name	documentation_versions
Type	Resource
Id	aws.apigateway.documentation_versions

Fields

The following fields are returned by SELECT queries:

get_documentation_version

Name	Datatype	Description
created_date	string (date-time)	The date when the API documentation snapshot is created.
description	string	The description of the API documentation snapshot.
version	string	The version identifier of the API documentation snapshot.

get_documentation_versions

Name	Datatype	Description
created_date	string (date-time)	The date when the API documentation snapshot is created.
description	string	The description of the API documentation snapshot.
version	string	The version identifier of the API documentation snapshot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_documentation_version	select	restapi_id, doc_version, region		Gets a documentation version.
get_documentation_versions	select	restapi_id, region	position, limit	Gets documentation versions.
create_documentation_version	insert	restapi_id, region, documentationVersion		Creates a documentation version
update_documentation_version	update	restapi_id, doc_version, region		Updates a documentation version.
delete_documentation_version	delete	restapi_id, doc_version, region		Deletes a documentation version.

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
doc_version	string	The version identifier of a to-be-deleted documentation snapshot.
region	string	AWS region (default: us-east-1)
restapi_id	string	The string identifier of the associated RestApi.
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_documentation_version

Gets a documentation version.

SELECT
created_date,
description,
version
FROM aws.apigateway.documentation_versions
WHERE restapi_id = '{{ restapi_id }}' -- required
AND doc_version = '{{ doc_version }}' -- required
AND region = '{{ region }}' -- required
;

get_documentation_versions

Gets documentation versions.

SELECT
created_date,
description,
version
FROM aws.apigateway.documentation_versions
WHERE restapi_id = '{{ restapi_id }}' -- required
AND region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_documentation_version

Creates a documentation version

INSERT INTO aws.apigateway.documentation_versions (
documentationVersion,
stageName,
description,
restapi_id,
region
)
SELECT 
'{{ documentationVersion }}' /* required */,
'{{ stageName }}',
'{{ description }}',
'{{ restapi_id }}',
'{{ region }}'
RETURNING
created_date,
description,
version
;

Manifest

# Description fields are for documentation purposes
- name: documentation_versions
props:
  - name: restapi_id
    value: "{{ restapi_id }}"
    description: Required parameter for the documentation_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the documentation_versions resource.
  - name: documentationVersion
    value: "{{ documentationVersion }}"
  - name: stageName
    value: "{{ stageName }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

update_documentation_version

Updates a documentation version.

UPDATE aws.apigateway.documentation_versions
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
restapi_id = '{{ restapi_id }}' --required
AND doc_version = '{{ doc_version }}' --required
AND region = '{{ region }}' --required
RETURNING
created_date,
description,
version;

DELETE examples

delete_documentation_version

Deletes a documentation version.

DELETE FROM aws.apigateway.documentation_versions
WHERE restapi_id = '{{ restapi_id }}' --required
AND doc_version = '{{ doc_version }}' --required
AND region = '{{ region }}' --required
;