Class: Openapi3Parser::Node::Schema

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi3_parser/node/schema.rb

Overview

rubocop:disable ClassLength

Instance Attribute Summary

Attributes inherited from Object

#node_context, #node_data

Instance Method Summary collapse

Methods inherited from Object

#[], #extension, #initialize, #inspect, #node_at, #render_markdown

Constructor Details

This class inherits a constructor from Openapi3Parser::Node::Object

Instance Method Details

#additional_properties?Boolean

Returns:

  • (Boolean)


126
127
128
# File 'lib/openapi3_parser/node/schema.rb', line 126

def additional_properties?
  node_data["additionalProperties"] != false
end

#additional_properties_schemaSchema?

Returns:



131
132
133
134
135
# File 'lib/openapi3_parser/node/schema.rb', line 131

def additional_properties_schema
  properties = node_data["additionalProperties"]
  return if [true, false].include?(properties)
  properties
end

#all_ofNode::Array<Schema>?

Returns:



96
97
98
# File 'lib/openapi3_parser/node/schema.rb', line 96

def all_of
  node_data["allOf"]
end

#any_ofNode::Array<Schema>?

Returns:



106
107
108
# File 'lib/openapi3_parser/node/schema.rb', line 106

def any_of
  node_data["anyOf"]
end

#defaultAny

Returns:

  • (Any)


153
154
155
# File 'lib/openapi3_parser/node/schema.rb', line 153

def default
  node_data["default"]
end

#deprecated?Boolean

Returns:

  • (Boolean)


193
194
195
# File 'lib/openapi3_parser/node/schema.rb', line 193

def deprecated?
  node_data["deprecated"]
end

#descriptionString?

Returns:

  • (String, nil)


138
139
140
# File 'lib/openapi3_parser/node/schema.rb', line 138

def description
  node_data["description"]
end

#description_htmlString?

Returns:

  • (String, nil)


143
144
145
# File 'lib/openapi3_parser/node/schema.rb', line 143

def description_html
  render_markdown(description)
end

#disciminatorDiscriminator?

Returns:



163
164
165
# File 'lib/openapi3_parser/node/schema.rb', line 163

def disciminator
  node_data["discriminator"]
end

#enumNode::Array<Object>?

Returns:



86
87
88
# File 'lib/openapi3_parser/node/schema.rb', line 86

def enum
  node_data["enum"]
end

#exampleAny

Returns:

  • (Any)


188
189
190
# File 'lib/openapi3_parser/node/schema.rb', line 188

def example
  node_data["example"]
end

#exclusive_maximum?Boolean

Returns:

  • (Boolean)


26
27
28
# File 'lib/openapi3_parser/node/schema.rb', line 26

def exclusive_maximum?
  node_data["exclusiveMaximum"]
end

#exclusive_minimum?Boolean

Returns:

  • (Boolean)


36
37
38
# File 'lib/openapi3_parser/node/schema.rb', line 36

def exclusive_minimum?
  node_data["exclusiveMinimum"]
end

#external_docsExternalDocumentation?

Returns:



183
184
185
# File 'lib/openapi3_parser/node/schema.rb', line 183

def external_docs
  node_data["externalDocs"]
end

#formatString?

Returns:

  • (String, nil)


148
149
150
# File 'lib/openapi3_parser/node/schema.rb', line 148

def format
  node_data["format"]
end

#itemsSchema?

Returns:



116
117
118
# File 'lib/openapi3_parser/node/schema.rb', line 116

def items
  node_data["items"]
end

#max_itemsInteger?

Returns:

  • (Integer, nil)


56
57
58
# File 'lib/openapi3_parser/node/schema.rb', line 56

def max_items
  node_data["maxItems"]
end

#max_lengthInteger?

Returns:

  • (Integer, nil)


41
42
43
# File 'lib/openapi3_parser/node/schema.rb', line 41

def max_length
  node_data["maxLength"]
end

#max_propertiesInteger?

Returns:

  • (Integer, nil)


71
72
73
# File 'lib/openapi3_parser/node/schema.rb', line 71

def max_properties
  node_data["maxProperties"]
end

#maximumInteger?

Returns:

  • (Integer, nil)


21
22
23
# File 'lib/openapi3_parser/node/schema.rb', line 21

def maximum
  node_data["maximum"]
end

#min_itemsInteger

Returns:

  • (Integer)


61
62
63
# File 'lib/openapi3_parser/node/schema.rb', line 61

def min_items
  node_data["minItems"]
end

#min_lengthInteger

Returns:

  • (Integer)


46
47
48
# File 'lib/openapi3_parser/node/schema.rb', line 46

def min_length
  node_data["minLength"]
end

#min_propertiesInteger

Returns:

  • (Integer)


76
77
78
# File 'lib/openapi3_parser/node/schema.rb', line 76

def min_properties
  node_data["minProperties"]
end

#minimumInteger?

Returns:

  • (Integer, nil)


31
32
33
# File 'lib/openapi3_parser/node/schema.rb', line 31

def minimum
  node_data["minimum"]
end

#multiple_ofNumeric?

Returns:

  • (Numeric, nil)


16
17
18
# File 'lib/openapi3_parser/node/schema.rb', line 16

def multiple_of
  node_data["multipleOf"]
end

#notSchema?

Returns:



111
112
113
# File 'lib/openapi3_parser/node/schema.rb', line 111

def not
  node_data["not"]
end

#nullable?Boolean

Returns:

  • (Boolean)


158
159
160
# File 'lib/openapi3_parser/node/schema.rb', line 158

def nullable?
  node_data["nullable"]
end

#one_ofNode::Array<Schema>?

Returns:



101
102
103
# File 'lib/openapi3_parser/node/schema.rb', line 101

def one_of
  node_data["oneOf"]
end

#patternString?

Returns:

  • (String, nil)


51
52
53
# File 'lib/openapi3_parser/node/schema.rb', line 51

def pattern
  node_data["pattern"]
end

#propertiesMap<String, Schema>

Returns:



121
122
123
# File 'lib/openapi3_parser/node/schema.rb', line 121

def properties
  node_data["properties"]
end

#read_only?Boolean

Returns:

  • (Boolean)


168
169
170
# File 'lib/openapi3_parser/node/schema.rb', line 168

def read_only?
  node_data["readOnly"]
end

#requiredNode::Array<String>?

Returns:



81
82
83
# File 'lib/openapi3_parser/node/schema.rb', line 81

def required
  node_data["required"]
end

#titleString?

Returns:

  • (String, nil)


11
12
13
# File 'lib/openapi3_parser/node/schema.rb', line 11

def title
  node_data["title"]
end

#typeString?

Returns:

  • (String, nil)


91
92
93
# File 'lib/openapi3_parser/node/schema.rb', line 91

def type
  node_data["type"]
end

#unique_items?Boolean

Returns:

  • (Boolean)


66
67
68
# File 'lib/openapi3_parser/node/schema.rb', line 66

def unique_items?
  node_data["uniqueItems"]
end

#write_only?Boolean

Returns:

  • (Boolean)


173
174
175
# File 'lib/openapi3_parser/node/schema.rb', line 173

def write_only?
  node_data["writeOnly"]
end

#xmlXml?

Returns:



178
179
180
# File 'lib/openapi3_parser/node/schema.rb', line 178

def xml
  node_data["xml"]
end