Amazonka.APIGateway.Types.DocumentationPartLocation

Documentation

data DocumentationPartLocation

Specifies the target API entity to which the documentation applies.

See: newDocumentationPartLocation smart constructor.

Constructors

DocumentationPartLocation'

Fields

• method :: Maybe Text

  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.

• name :: Maybe Text

  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.

• path :: Maybe Text

  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.

• statusCode :: Maybe Text

  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.

• type' :: DocumentationPartType

  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.

Instances

FromJSON DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

parseJSON :: Value -> Parser DocumentationPartLocation

parseJSONList :: Value -> Parser [DocumentationPartLocation]

ToJSON DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

toJSON :: DocumentationPartLocation -> Value

toEncoding :: DocumentationPartLocation -> Encoding

toJSONList :: [DocumentationPartLocation] -> Value

toEncodingList :: [DocumentationPartLocation] -> Encoding

Generic DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Associated Types

type Rep DocumentationPartLocation :: Type -> Type

Methods

from :: DocumentationPartLocation -> Rep DocumentationPartLocation x

to :: Rep DocumentationPartLocation x -> DocumentationPartLocation

Read DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

readsPrec :: Int -> ReadS DocumentationPartLocation

readList :: ReadS [DocumentationPartLocation]

readPrec :: ReadPrec DocumentationPartLocation

readListPrec :: ReadPrec [DocumentationPartLocation]

Show DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

showsPrec :: Int -> DocumentationPartLocation -> ShowS

show :: DocumentationPartLocation -> String

showList :: [DocumentationPartLocation] -> ShowS

NFData DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

rnf :: DocumentationPartLocation -> ()

Eq DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

(==) :: DocumentationPartLocation -> DocumentationPartLocation -> Bool

(/=) :: DocumentationPartLocation -> DocumentationPartLocation -> Bool

Hashable DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

Methods

hashWithSalt :: Int -> DocumentationPartLocation -> Int

hash :: DocumentationPartLocation -> Int

type Rep DocumentationPartLocation

Defined in Amazonka.APIGateway.Types.DocumentationPartLocation

type Rep DocumentationPartLocation = D1 ('MetaData "DocumentationPartLocation" "Amazonka.APIGateway.Types.DocumentationPartLocation" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPartLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentationPartType)))))

newDocumentationPartLocation

Arguments

:: DocumentationPartType

$sel:type':DocumentationPartLocation'

-> DocumentationPartLocation

Create a value of DocumentationPartLocation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:method:DocumentationPartLocation', documentationPartLocation_method - 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.

$sel:name:DocumentationPartLocation', documentationPartLocation_name - 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.

$sel:path:DocumentationPartLocation', documentationPartLocation_path - 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.

$sel:statusCode:DocumentationPartLocation', documentationPartLocation_statusCode - 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.

$sel:type':DocumentationPartLocation', documentationPartLocation_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.

documentationPartLocation_method :: Lens' DocumentationPartLocation (Maybe Text)

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.

documentationPartLocation_name :: Lens' DocumentationPartLocation (Maybe Text)

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.

documentationPartLocation_path :: Lens' DocumentationPartLocation (Maybe Text)

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.

documentationPartLocation_statusCode :: Lens' DocumentationPartLocation (Maybe Text)

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.

documentationPartLocation_type :: Lens' DocumentationPartLocation DocumentationPartType

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.