Class: Spikard::OpenApiConfig

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ OpenApiConfig

Returns a new instance of OpenApiConfig.

Parameters:

  • enabled: (Boolean)
  • title: (String)
  • version: (String)
  • description: (String)
  • swagger_ui_path: (String)
  • redoc_path: (String)
  • openapi_json_path: (String)
  • contact: (ContactInfo)
  • license: (LicenseInfo)
  • servers: (Array[ServerInfo])
  • security_schemes: (Hash[String, SecuritySchemeInfo]) 


171
 
# File 'sig/types.rbs', line 171

def initialize: (?enabled: bool, ?title: String, ?version: String, ?description: String, ?swagger_ui_path: String, ?redoc_path: String, ?openapi_json_path: String, ?contact: ContactInfo, ?license: LicenseInfo, ?servers: Array[ServerInfo], ?security_schemes: Hash[String, SecuritySchemeInfo]) -> void

Instance Attribute Details

#contact ⇒ ContactInfo?

Returns the value of attribute contact.

Returns:



166
167
168
 
# File 'sig/types.rbs', line 166

def contact
  @contact
end

#description ⇒ String?

Returns the value of attribute description.

Returns:

  • (String, nil) 


162
163
164
 
# File 'sig/types.rbs', line 162

def description
  @description
end

#enabled ⇒ Boolean?

Returns the value of attribute enabled.

Returns:

  • (Boolean, nil) 


159
160
161
 
# File 'sig/types.rbs', line 159

def enabled
  @enabled
end

#license ⇒ LicenseInfo?

Returns the value of attribute license.

Returns:



167
168
169
 
# File 'sig/types.rbs', line 167

def license
  @license
end

#openapi_json_path ⇒ String?

Returns the value of attribute openapi_json_path.

Returns:

  • (String, nil) 


165
166
167
 
# File 'sig/types.rbs', line 165

def openapi_json_path
  @openapi_json_path
end

#redoc_path ⇒ String?

Returns the value of attribute redoc_path.

Returns:

  • (String, nil) 


164
165
166
 
# File 'sig/types.rbs', line 164

def redoc_path
  @redoc_path
end

#security_schemes ⇒ Hash[String, SecuritySchemeInfo]?

Returns the value of attribute security_schemes.

Returns:



169
170
171
 
# File 'sig/types.rbs', line 169

def security_schemes
  @security_schemes
end

#servers ⇒ Array[ServerInfo]?

Returns the value of attribute servers.

Returns:



168
169
170
 
# File 'sig/types.rbs', line 168

def servers
  @servers
end

#swagger_ui_path ⇒ String?

Returns the value of attribute swagger_ui_path.

Returns:

  • (String, nil) 


163
164
165
 
# File 'sig/types.rbs', line 163

def swagger_ui_path
  @swagger_ui_path
end

#title ⇒ String?

Returns the value of attribute title.

Returns:

  • (String, nil) 


160
161
162
 
# File 'sig/types.rbs', line 160

def title
  @title
end

#version ⇒ String?

Returns the value of attribute version.

Returns:

  • (String, nil) 


161
162
163
 
# File 'sig/types.rbs', line 161

def version
  @version
end

Class Method Details

.default ⇒ OpenApiConfig

Returns:



172
 
# File 'sig/types.rbs', line 172

def self.default: () -> OpenApiConfig