Class: Gitlab::GrapeOpenapi::Models::Operation

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/grape_openapi/models/operation.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Operation

Returns a new instance of Operation.



11
12
13
14
15
16
17
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 11

def initialize
  @tags = []
  @request_body = {}
  @parameters = []
  @deprecated = false
  @annotations = nil
end

Instance Attribute Details

#annotations ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def annotations
  @annotations
end

#deprecated ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def deprecated
  @deprecated
end

#description ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def description
  @description
end

#hidden ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def hidden
  @hidden
end

#operation_id ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def operation_id
  @operation_id
end

#parameters ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def parameters
  @parameters
end

#request_body ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def request_body
  @request_body
end

#responses ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def responses
  @responses
end

#summary ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def summary
  @summary
end

#tags ⇒ Object

github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object



8
9
10
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 8

def tags
  @tags
end

Instance Method Details

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 19

def hidden?
  @hidden
end

#to_h ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/gitlab/grape_openapi/models/operation.rb', line 23

def to_h
  @parameters ||= []

  o = {
    operationId: operation_id,
    summary: summary,
    description: description,
    tags: tags && tags.empty? ? nil : tags,
    responses: responses
  }.compact

  o[:deprecated] = deprecated if deprecated
  o[:parameters] = parameters.map(&:to_h) if parameters.any?
  o[:requestBody] = request_body if request_body.keys.any?

  annotations&.each do |k, v|
    o[k] = v
  end

  o
end