You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::DocumentationPartLocation

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DocumentationPartLocation as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
  path: "String",
  method: "String",
  status_code: "DocumentationPartLocationStatusCode",
  name: "String",
}

Specifies the target API entity to which the documentation applies.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#methodString

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.

Returns:

  • (String)

    The HTTP verb of a method.

#nameString

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.

Returns:

  • (String)

    The name of the targeted API entity.

#pathString

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.

Returns:

  • (String)

    The URL path of the target.

#status_codeString

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.

Returns:

  • (String)

    The HTTP status code of a response.

#typeString

The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of 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.

Possible values:

  • API
  • AUTHORIZER
  • MODEL
  • RESOURCE
  • METHOD
  • PATH_PARAMETER
  • QUERY_PARAMETER
  • REQUEST_HEADER
  • REQUEST_BODY
  • RESPONSE
  • RESPONSE_HEADER
  • RESPONSE_BODY

Returns:

  • (String)

    The type of API entity to which the documentation content applies.