aws_api_gateway_documentation

Use the aws_api_gateway_documentation_versions InSpec audit resource to test properties of multiple AWS API Gateway documentation versions.

The AWS::ApiGateway::DocumentationParts resource creates a documentation versions for an API.

For additional information, including details on parameters and properties, see the AWS ApiGateway Documentation Version documentation.

Syntax

Ensure that the documentation version exists.

describe aws_api_gateway_documentation_versions(rest_api_id: 'REST_API_ID') do
  it { should exist }
end

rest_api_id (required)

created_dates: The date when the API documentation snapshot is created.; Field: created_date
versions: The version identifier of the API documentation snapshot.; Field: version
descriptions: The description of the API documentation snapshot.; Field: description

Ensure that the documentation versions ID exists:

describe aws_api_gateway_documentation_versions(rest_api_id: 'REST_API_ID') do
  its('versions') { should include 'VERSION' }
end

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

Use should to test that the entity exists.

describe aws_api_gateway_documentation_versions(rest_api_id: 'REST_API_ID') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_api_gateway_documentation_versions(rest_api_id: 'REST_API_ID') do
  it { should_not exist }
end

Use should to check if the documentation versions is available.

describe aws_api_gateway_documentation_versions(rest_api_id: 'REST_API_ID') do
  it { should be_available }
end

Your AWS principal will need the APIGateway:Client::DocumentationVersions action with Effect set to Allow.