Class: OpenAPIParser::Schemas::Schema

Inherits:

Base

• Object
• Base
• OpenAPIParser::Schemas::Schema

Defined in:

lib/openapi_parser/schemas/schema.rb,
lib/openapi_parser/schemas/classes.rb

Instance Attribute Summary

• #additional_properties ⇒ Object readonly

  additional_properties have default value we should add default value feature in openapi_attr_object method, but we need temporary fix so override attr_reader.

• #all_of ⇒ Array<Schema, Reference>^? readonly
• #any_of ⇒ Array<Schema, Reference>^? readonly
• #default ⇒ Object^? readonly
• #deprecated ⇒ Boolean^? readonly
• #description ⇒ String^? readonly
• #discriminator ⇒ Discriminator^? readonly
• #enum ⇒ Array^? readonly

  Any type array.

• #example ⇒ Object^? readonly
• #exclusiveMaximum ⇒ Boolean^? readonly
• #exclusiveMinimum ⇒ Boolean^? readonly
• #format ⇒ String^? readonly
• #items ⇒ Schema^? readonly
• #maximum ⇒ Float^? readonly
• #maxItems ⇒ Integer^? readonly
• #maxLength ⇒ Integer^? readonly
• #maxProperties ⇒ Integer^? readonly
• #minItems ⇒ Integer^? readonly
• #minLength ⇒ Integer^? readonly
• #minProperties ⇒ Integer^? readonly
• #multipleOf ⇒ Float^? readonly
• #nullable ⇒ Boolean^? readonly
• #one_of ⇒ Array<Schema, Reference>^? readonly
• #pattern ⇒ String^? readonly

  Regexp.

• #properties ⇒ Hash{String => Schema}^? readonly
• #read_only ⇒ Boolean^? readonly
• #required ⇒ Array<String>^? readonly

  At least one item included.

• #title ⇒ String^? readonly
• #type ⇒ String^? readonly

  Multiple types doesn’t supported in OpenAPI3.

• #uniqueItems ⇒ Boolean^? readonly
• #write_only ⇒ Boolean^? readonly

Attributes inherited from Base

#object_reference, #parent, #raw_schema, #root

Method Summary

Methods inherited from Base

#after_init, #initialize, #inspect

Methods included from Expandable

#expand_reference

Methods included from Findable

#find_object, #purge_object_cache

Methods included from Parser

#_openapi_all_child_objects, #_update_child_object, included, #load_data

Constructor Details

This class inherits a constructor from OpenAPIParser::Schemas::Base

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

additional_properties have default value we should add default value feature in openapi_attr_object method, but we need temporary fix so override attr_reader

# File 'lib/openapi_parser/schemas/schema.rb', line 110

openapi_attr_object :additional_properties, Schema, reference: true, allow_data_type: true, schema_key: :additionalProperties

#all_of ⇒ Array<Schema, Reference>^? (readonly)

Returns:

• (Array<Schema, Reference>, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 86

openapi_attr_list_object :all_of, Schema, reference: true, schema_key: :allOf

#any_of ⇒ Array<Schema, Reference>^? (readonly)

Returns:

• (Array<Schema, Reference>, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 94

openapi_attr_list_object :any_of, Schema, reference: true, schema_key: :anyOf

#default ⇒ Object^? (readonly)

Returns:

• (Object, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 55

#deprecated ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 38

#description ⇒ String^? (readonly)

Returns:

• (String, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 7

#discriminator ⇒ Discriminator^? (readonly)

Returns:

• (Discriminator, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 106

openapi_attr_object :discriminator, Discriminator

#enum ⇒ Array^? (readonly)

Returns any type array.

Returns:

• (Array, nil) —

  any type array

# File 'lib/openapi_parser/schemas/schema.rb', line 52

#example ⇒ Object^? (readonly)

Returns:

• (Object, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 61

openapi_attr_values :title, :multipleOf,
:maximum, :exclusiveMaximum, :minimum, :exclusiveMinimum,
:maxLength, :minLength,
:pattern,
:maxItems, :minItems, :uniqueItems,
:maxProperties, :minProperties,
:required, :enum,
:description,
:format,
:default,
:type,
:nullable,
:example,
:deprecated

#exclusiveMaximum ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 38

#exclusiveMinimum ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 38

#format ⇒ String^? (readonly)

Returns:

• (String, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 7

#items ⇒ Schema^? (readonly)

Returns:

• (Schema, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 98

openapi_attr_object :items, Schema, reference: true

#maximum ⇒ Float^? (readonly)

Returns:

• (Float, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 20

#maxItems ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#maxLength ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#maxProperties ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#minItems ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#minLength ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#minProperties ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 25

#multipleOf ⇒ Float^? (readonly)

Returns:

• (Float, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 20

#nullable ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 38

#one_of ⇒ Array<Schema, Reference>^? (readonly)

Returns:

• (Array<Schema, Reference>, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 90

openapi_attr_list_object :one_of, Schema, reference: true, schema_key: :oneOf

#pattern ⇒ String^? (readonly)

Returns regexp.

Returns:

• (String, nil) —

  regexp

# File 'lib/openapi_parser/schemas/schema.rb', line 7

#properties ⇒ Hash{String => Schema}^? (readonly)

Returns:

• (Hash{String => Schema}, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 102

openapi_attr_hash_object :properties, Schema, reference: true

#read_only ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 78

openapi_attr_value :read_only, schema_key: :readOnly

#required ⇒ Array<String>^? (readonly)

Returns at least one item included.

Returns:

• (Array<String>, nil) —

  at least one item included

# File 'lib/openapi_parser/schemas/schema.rb', line 49

#title ⇒ String^? (readonly)

Returns:

• (String, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 7

#type ⇒ String^? (readonly)

Returns multiple types doesn’t supported in OpenAPI3.

Returns:

• (String, nil) —

  multiple types doesn’t supported in OpenAPI3

# File 'lib/openapi_parser/schemas/schema.rb', line 7

#uniqueItems ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 38

#write_only ⇒ Boolean^? (readonly)

Returns:

• (Boolean, nil)

# File 'lib/openapi_parser/schemas/schema.rb', line 82

openapi_attr_value :write_only, schema_key: :writeOnly