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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DocumentationPartLocation

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass DocumentationPartLocation data as a 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.

Instance Attribute Summary

• #method ⇒ String

  The HTTP verb of a method.

• #name ⇒ String

  The name of the targeted API entity.

• #path ⇒ String

  The URL path of the target.

• #status_code ⇒ String

  The HTTP status code of a response.

• #type ⇒ String

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

Instance Attribute Details

#method ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 1967

class DocumentationPartLocation < Struct.new(
  :type,
  :path,
  :method,
  :status_code,
  :name)
  include Aws::Structure
end

#name ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 1967

class DocumentationPartLocation < Struct.new(
  :type,
  :path,
  :method,
  :status_code,
  :name)
  include Aws::Structure
end

#path ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 1967

class DocumentationPartLocation < Struct.new(
  :type,
  :path,
  :method,
  :status_code,
  :name)
  include Aws::Structure
end

#status_code ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 1967

class DocumentationPartLocation < Struct.new(
  :type,
  :path,
  :method,
  :status_code,
  :name)
  include Aws::Structure
end

#type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1967

class DocumentationPartLocation < Struct.new(
  :type,
  :path,
  :method,
  :status_code,
  :name)
  include Aws::Structure
end