/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Specifies the target API entity to which the documentation
* applies.See Also:
AWS
* API Reference
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The type of API entity to which the documentation content applies. Valid
* values are API
, AUTHORIZER
, MODEL
,
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. Content inheritance does not apply to any entity
* of the API
, AUTHORIZER
, METHOD
,
* MODEL
, REQUEST_BODY
, or RESOURCE
* type.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The URL path of the target. It is a valid field for the API entity types of
* RESOURCE
, METHOD
, PATH_PARAMETER
,
* QUERY_PARAMETER
, REQUEST_HEADER
,
* REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
,
* and RESPONSE_BODY
. The default value is /
for the root
* resource. When an applicable child entity inherits the content of another entity
* of the same type with more general specifications of the other
* location
attributes, the child entity's path
attribute
* must match that of the parent entity as a prefix.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP verb of a method. It is a valid field for the API entity types of
* METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
,
* RESPONSE_HEADER
, and RESPONSE_BODY
. The default value
* is *
for any method. When an applicable child entity inherits the
* content of an entity of the same type with more general specifications of the
* other location
attributes, the child entity's method
* attribute must match that of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity
* types of RESPONSE
, RESPONSE_HEADER
, and
* RESPONSE_BODY
. The default value is *
for any status
* code. When an applicable child entity inherits the content of an entity of the
* same type with more general specifications of the other location
* attributes, the child entity's statusCode
attribute must match that
* of the parent entity exactly.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.
The name of the targeted API entity. It is a valid and required field for the
* API entity types of AUTHORIZER
, MODEL
,
* PATH_PARAMETER
, QUERY_PARAMETER
,
* REQUEST_HEADER
, REQUEST_BODY
and
* RESPONSE_HEADER
. It is an invalid field for any other entity
* type.