class Open::Api

Included Modules

Extended Modules

Defined in:

open-api.cr
open-api/components.cr
open-api/header.cr
open-api/info.cr
open-api/media_type.cr
open-api/operation.cr
open-api/operation_item.cr
open-api/parameter.cr
open-api/path_item.cr
open-api/ref.cr
open-api/response.cr
open-api/schema.cr
open-api/server.cr
open-api/version.cr

Constant Summary

VERSION = "0.1.3"

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(info : Open::Api::Info) #

[View source]
def self.new(title : String) #

[View source]

Class Method Detail

def self.route_meta #

[View source]
def self.route_meta=(route_meta : Hash(String, Hash(String, Hash(Symbol, Bool | Hash(Symbol, String) | NamedTuple(method: -> Open::Api::Schema, key: String) | Open::Api::Schema | String | Nil)))) #

[View source]
def self.schema_refs #

[View source]
def self.schema_refs=(schema_refs : Hash(String, Open::Api::Schema)) #

[View source]

Instance Method Detail

def components : Open::Api::Components #

[View source]
def components=(components : Open::Api::Components) #

[View source]
def info : Open::Api::Info #

[View source]
def info=(info : Open::Api::Info) #

[View source]
def openapi : String #

[View source]
def openapi=(openapi : String) #

[View source]
def paths : Open::Api::Paths #

[View source]
def paths=(paths : Open::Api::Paths) #

[View source]
def servers : Array(Open::Api::Server) #

[View source]
def servers=(servers : Array(Open::Api::Server)) #

[View source]