Class: Spikard::ProblemDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeProblemDetails

Returns a new instance of ProblemDetails.

Parameters:

  • type_uri: (String)
  • title: (String)
  • status: (Integer)
  • detail: (String)
  • instance: (String)
  • extensions: (Hash[String, json_value])


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

def initialize: (type_uri: String, title: String, status: Integer, ?detail: String, ?instance: String, extensions: Hash[String, json_value]) -> void

Instance Attribute Details

#detailString (readonly)

Returns the value of attribute detail.

Returns:

  • (String)


310
311
312
# File 'sig/types.rbs', line 310

def detail
  @detail
end

#extensionsHash[String, json_value] (readonly)

Returns the value of attribute extensions.

Returns:

  • (Hash[String, json_value])


312
313
314
# File 'sig/types.rbs', line 312

def extensions
  @extensions
end

#instanceString (readonly)

Returns the value of attribute instance.

Returns:

  • (String)


311
312
313
# File 'sig/types.rbs', line 311

def instance
  @instance
end

#statusInteger (readonly)

Returns the value of attribute status.

Returns:

  • (Integer)


309
310
311
# File 'sig/types.rbs', line 309

def status
  @status
end

#titleString (readonly)

Returns the value of attribute title.

Returns:

  • (String)


308
309
310
# File 'sig/types.rbs', line 308

def title
  @title
end

#type_uriString (readonly)

Returns the value of attribute type_uri.

Returns:

  • (String)


307
308
309
# File 'sig/types.rbs', line 307

def type_uri
  @type_uri
end

Class Method Details

.bad_requestProblemDetails

Parameters:

  • detail (String)

Returns:



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

def self.bad_request: (String detail) -> ProblemDetails

.internal_server_errorProblemDetails

Parameters:

  • detail (String)

Returns:



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

def self.internal_server_error: (String detail) -> ProblemDetails

.method_not_allowedProblemDetails

Parameters:

  • detail (String)

Returns:



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

def self.method_not_allowed: (String detail) -> ProblemDetails

.not_foundProblemDetails

Parameters:

  • detail (String)

Returns:



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

def self.not_found: (String detail) -> ProblemDetails

Instance Method Details

#to_jsonString

Returns:

  • (String)


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

def to_json: () -> String

#to_json_prettyString

Returns:

  • (String)


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

def to_json_pretty: () -> String

#with_detailProblemDetails

Parameters:

  • detail (String)

Returns:



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

def with_detail: (String detail) -> ProblemDetails

#with_instanceProblemDetails

Parameters:

Returns:



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

def with_instance: (String instance) -> ProblemDetails