enum Swagger::Objects::Parameter::Location

Overview

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameter-locations

Defined in:

swagger/objects/parameter.cr

Enum Members

Path = 0
Query = 1
Header = 2
Cookie = 3

Instance Method Summary

Instance Method Detail

def cookie? #

[View source]
def header? #

[View source]
def path? #

[View source]
def query? #

[View source]
def to_json(builder : JSON::Builder) #
Description copied from struct Enum

Serializes this enum member by name.

For non-flags enums, the serialization is a JSON string. The value is the member name (see #to_s) transformed with String#underscore.

enum Stages
  INITIAL
  SECOND_STAGE
end

Stages::INITIAL.to_json      # => %("initial")
Stages::SECOND_STAGE.to_json # => %("second_stage")

For flags enums, the serialization is a JSON array including every flagged member individually serialized in the same way as a member of a non-flags enum. None is serialized as an empty array, All as an array containing all members.

@[Flags]
enum Sides
  LEFT
  RIGHT
end

Sides::LEFT.to_json                  # => %(["left"])
(Sides::LEFT | Sides::RIGHT).to_json # => %(["left","right"])
Sides::All.to_json                   # => %(["left","right"])
Sides::None.to_json                  # => %([])

ValueConverter.to_json offers a different serialization strategy based on the member value.


[View source]