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]) 


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

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:



182
183
184
 
# File 'sig/types.rbs', line 182

def contact
  @contact
end

#description ⇒ String?

Returns the value of attribute description.

Returns:

  • (String, nil) 


178
179
180
 
# File 'sig/types.rbs', line 178

def description
  @description
end

#enabled ⇒ Boolean?

Returns the value of attribute enabled.

Returns:

  • (Boolean, nil) 


175
176
177
 
# File 'sig/types.rbs', line 175

def enabled
  @enabled
end

#license ⇒ LicenseInfo?

Returns the value of attribute license.

Returns:



183
184
185
 
# File 'sig/types.rbs', line 183

def license
  @license
end

#openapi_json_path ⇒ String?

Returns the value of attribute openapi_json_path.

Returns:

  • (String, nil) 


181
182
183
 
# File 'sig/types.rbs', line 181

def openapi_json_path
  @openapi_json_path
end

#redoc_path ⇒ String?

Returns the value of attribute redoc_path.

Returns:

  • (String, nil) 


180
181
182
 
# File 'sig/types.rbs', line 180

def redoc_path
  @redoc_path
end

#security_schemes ⇒ Hash[String, SecuritySchemeInfo]?

Returns the value of attribute security_schemes.

Returns:



185
186
187
 
# File 'sig/types.rbs', line 185

def security_schemes
  @security_schemes
end

#servers ⇒ Array[ServerInfo]?

Returns the value of attribute servers.

Returns:



184
185
186
 
# File 'sig/types.rbs', line 184

def servers
  @servers
end

#swagger_ui_path ⇒ String?

Returns the value of attribute swagger_ui_path.

Returns:

  • (String, nil) 


179
180
181
 
# File 'sig/types.rbs', line 179

def swagger_ui_path
  @swagger_ui_path
end

#title ⇒ String?

Returns the value of attribute title.

Returns:

  • (String, nil) 


176
177
178
 
# File 'sig/types.rbs', line 176

def title
  @title
end

#version ⇒ String?

Returns the value of attribute version.

Returns:

  • (String, nil) 


177
178
179
 
# File 'sig/types.rbs', line 177

def version
  @version
end

Class Method Details

.default ⇒ OpenApiConfig

Returns:



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

def self.default: () -> OpenApiConfig