Class: Yori::Schema::V3::Info

Inherits:

Yori::SchemaBase

• Object
• Hash
• Yori::SchemaBase
• Yori::Schema::V3::Info

Defined in:

lib/yori/schema/v3/info.rb

Overview

Info: The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience. @title: REQUIRED. The title of the application. @description: A short description of the application. CommonMark syntax MAY be used for rich text representation. @termsOfService: A URL to the Terms of Service for the API. MUST be in the format of a URL. @contact: The contact information for the exposed API. @license: The license information for the exposed API. @version: REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

Instance Attribute Summary

Attributes inherited from Yori::SchemaBase

#id

Instance Method Summary

• #validate! ⇒ Object

Methods inherited from Yori::SchemaBase

eval_class!, eval_hash!, eval_input!, #ref, #validator

Instance Method Details

#validate! ⇒ Object

# File 'lib/yori/schema/v3/info.rb', line 21

def validate!
  validate_require_fields!('title', 'version')
end