Class: GrapeOAS::ApiModel::RequestBody

Inherits:
Node
  • Object
show all
Defined in:
lib/grape_oas/api_model/request_body.rb

Overview

Represents a request body in the DTO model for OpenAPI v2/v3. Used to describe the payload of HTTP requests, including content type and schema.

See Also:

Constant Summary

Constants inherited from Node

Node::BUCKET_NAMES

Instance Attribute Summary collapse

Attributes inherited from Node

#id

Instance Method Summary collapse

Methods inherited from Node

bucket, #ref

Constructor Details

#initialize(description: nil, required: false, media_types: [], extensions: nil, body_name: nil) ⇒ RequestBody

Returns a new instance of RequestBody.



13
14
15
16
17
18
19
20
 
# File 'lib/grape_oas/api_model/request_body.rb', line 13

def initialize(description: nil, required: false, media_types: [], extensions: nil, body_name: nil)
  super()
  @description = description
  @required    = required
  @media_types = Array(media_types)
  @extensions  = extensions
  @body_name   = body_name
end

Instance Attribute Details

#body_name ⇒ Object

Returns the value of attribute body_name.



11
12
13
 
# File 'lib/grape_oas/api_model/request_body.rb', line 11

def body_name
  @body_name
end

#description ⇒ Object

Returns the value of attribute description.



11
12
13
 
# File 'lib/grape_oas/api_model/request_body.rb', line 11

def description
  @description
end

#extensions ⇒ Object

Returns the value of attribute extensions.



11
12
13
 
# File 'lib/grape_oas/api_model/request_body.rb', line 11

def extensions
  @extensions
end

#media_types ⇒ Object

Returns the value of attribute media_types.



11
12
13
 
# File 'lib/grape_oas/api_model/request_body.rb', line 11

def media_types
  @media_types
end

#required ⇒ Object

Returns the value of attribute required.



11
12
13
 
# File 'lib/grape_oas/api_model/request_body.rb', line 11

def required
  @required
end

Instance Method Details

#add_media_type(media_type) ⇒ Object 



22
23
24
 
# File 'lib/grape_oas/api_model/request_body.rb', line 22

def add_media_type(media_type)
  @media_types << media_type
end