xitrum.annotation

Swagger

Related Docs: class Swagger | package annotation

object Swagger extends Serializable

See: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Swagger
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class BinaryBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerBinaryParam with Product with Serializable

  2. case class BinaryForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerBinaryParam with Product with Serializable

  3. case class BinaryHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerBinaryParam with Product with Serializable

  4. case class BinaryPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerBinaryParam with Product with Serializable

  5. case class BinaryQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerBinaryParam with Product with Serializable

  6. case class BooleanBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerBooleanParam with Product with Serializable

  7. case class BooleanForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerBooleanParam with Product with Serializable

  8. case class BooleanHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerBooleanParam with Product with Serializable

  9. case class BooleanPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerBooleanParam with Product with Serializable

  10. case class BooleanQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerBooleanParam with Product with Serializable

  11. case class ByteBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerByteParam with Product with Serializable

  12. case class ByteForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerByteParam with Product with Serializable

  13. case class ByteHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerByteParam with Product with Serializable

  14. case class BytePath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerByteParam with Product with Serializable

  15. case class ByteQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerByteParam with Product with Serializable

  16. case class Consumes(contentTypes: String*) extends SwaggerArg with Product with Serializable

  17. case class DateBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerDateParam with Product with Serializable

  18. case class DateForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerDateParam with Product with Serializable

  19. case class DateHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerDateParam with Product with Serializable

  20. case class DatePath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerDateParam with Product with Serializable

  21. case class DateQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerDateParam with Product with Serializable

  22. case class DateTimeBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerDateTimeParam with Product with Serializable

  23. case class DateTimeForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerDateTimeParam with Product with Serializable

  24. case class DateTimeHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerDateTimeParam with Product with Serializable

  25. case class DateTimePath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerDateTimeParam with Product with Serializable

  26. case class DateTimeQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerDateTimeParam with Product with Serializable

  27. case class Description(desc: String) extends SwaggerArg with Product with Serializable

  28. case class DoubleBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerDoubleParam with Product with Serializable

  29. case class DoubleForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerDoubleParam with Product with Serializable

  30. case class DoubleHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerDoubleParam with Product with Serializable

  31. case class DoublePath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerDoubleParam with Product with Serializable

  32. case class DoubleQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerDoubleParam with Product with Serializable

  33. case class ExternalDocs(url: String, desc: String = "") extends SwaggerArg with Product with Serializable

  34. case class FileForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerFileParam with Product with Serializable

  35. case class FloatBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerFloatParam with Product with Serializable

  36. case class FloatForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerFloatParam with Product with Serializable

  37. case class FloatHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerFloatParam with Product with Serializable

  38. case class FloatPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerFloatParam with Product with Serializable

  39. case class FloatQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerFloatParam with Product with Serializable

  40. case class IntBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerIntParam with Product with Serializable

  41. case class IntForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerIntParam with Product with Serializable

  42. case class IntHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerIntParam with Product with Serializable

  43. case class IntPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerIntParam with Product with Serializable

  44. case class IntQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerIntParam with Product with Serializable

  45. case class LongBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerLongParam with Product with Serializable

  46. case class LongForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerLongParam with Product with Serializable

  47. case class LongHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerLongParam with Product with Serializable

  48. case class LongPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerLongParam with Product with Serializable

  49. case class LongQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerLongParam with Product with Serializable

  50. case class OperationId(id: String) extends SwaggerArg with Product with Serializable

  51. case class OptBinaryBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerBinaryParam with Product with Serializable

  52. case class OptBinaryForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerBinaryParam with Product with Serializable

  53. case class OptBinaryHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerBinaryParam with Product with Serializable

  54. case class OptBinaryPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerBinaryParam with Product with Serializable

  55. case class OptBinaryQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerBinaryParam with Product with Serializable

  56. case class OptBooleanBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerBooleanParam with Product with Serializable

  57. case class OptBooleanForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerBooleanParam with Product with Serializable

  58. case class OptBooleanHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerBooleanParam with Product with Serializable

  59. case class OptBooleanPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerBooleanParam with Product with Serializable

  60. case class OptBooleanQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerBooleanParam with Product with Serializable

  61. case class OptByteBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerByteParam with Product with Serializable

  62. case class OptByteForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerByteParam with Product with Serializable

  63. case class OptByteHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerByteParam with Product with Serializable

  64. case class OptBytePath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerByteParam with Product with Serializable

  65. case class OptByteQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerByteParam with Product with Serializable

  66. case class OptDateBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerDateParam with Product with Serializable

  67. case class OptDateForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerDateParam with Product with Serializable

  68. case class OptDateHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerDateParam with Product with Serializable

  69. case class OptDatePath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerDateParam with Product with Serializable

  70. case class OptDateQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerDateParam with Product with Serializable

  71. case class OptDateTimeBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerDateTimeParam with Product with Serializable

  72. case class OptDateTimeForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerDateTimeParam with Product with Serializable

  73. case class OptDateTimeHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerDateTimeParam with Product with Serializable

  74. case class OptDateTimePath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerDateTimeParam with Product with Serializable

  75. case class OptDateTimeQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerDateTimeParam with Product with Serializable

  76. case class OptDoubleBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerDoubleParam with Product with Serializable

  77. case class OptDoubleForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerDoubleParam with Product with Serializable

  78. case class OptDoubleHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerDoubleParam with Product with Serializable

  79. case class OptDoublePath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerDoubleParam with Product with Serializable

  80. case class OptDoubleQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerDoubleParam with Product with Serializable

  81. case class OptFileForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerFileParam with Product with Serializable

  82. case class OptFloatBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerFloatParam with Product with Serializable

  83. case class OptFloatForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerFloatParam with Product with Serializable

  84. case class OptFloatHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerFloatParam with Product with Serializable

  85. case class OptFloatPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerFloatParam with Product with Serializable

  86. case class OptFloatQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerFloatParam with Product with Serializable

  87. case class OptIntBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerIntParam with Product with Serializable

  88. case class OptIntForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerIntParam with Product with Serializable

  89. case class OptIntHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerIntParam with Product with Serializable

  90. case class OptIntPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerIntParam with Product with Serializable

  91. case class OptIntQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerIntParam with Product with Serializable

  92. case class OptLongBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerLongParam with Product with Serializable

  93. case class OptLongForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerLongParam with Product with Serializable

  94. case class OptLongHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerLongParam with Product with Serializable

  95. case class OptLongPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerLongParam with Product with Serializable

  96. case class OptLongQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerLongParam with Product with Serializable

  97. case class OptPasswordBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerPasswordParam with Product with Serializable

  98. case class OptPasswordForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerPasswordParam with Product with Serializable

  99. case class OptPasswordHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerPasswordParam with Product with Serializable

  100. case class OptPasswordPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerPasswordParam with Product with Serializable

  101. case class OptPasswordQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerPasswordParam with Product with Serializable

  102. case class OptStringBody(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerBodyParam with SwaggerStringParam with Product with Serializable

  103. case class OptStringForm(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerFormParam with SwaggerStringParam with Product with Serializable

  104. case class OptStringHeader(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerHeaderParam with SwaggerStringParam with Product with Serializable

  105. case class OptStringPath(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerPathParam with SwaggerStringParam with Product with Serializable

  106. case class OptStringQuery(name: String, desc: String = "") extends SwaggerOptParamArg with SwaggerQueryParam with SwaggerStringParam with Product with Serializable

  107. case class PasswordBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerPasswordParam with Product with Serializable

  108. case class PasswordForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerPasswordParam with Product with Serializable

  109. case class PasswordHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerPasswordParam with Product with Serializable

  110. case class PasswordPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerPasswordParam with Product with Serializable

  111. case class PasswordQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerPasswordParam with Product with Serializable

  112. case class Produces(contentTypes: String*) extends SwaggerArg with Product with Serializable

  113. case class Response(code: Int = 0, desc: String) extends SwaggerArg with Product with Serializable

    Can use this multiple times at an action.

  114. case class Schemes(schemes: String*) extends SwaggerArg with Product with Serializable

  115. case class StringBody(name: String, desc: String = "") extends SwaggerParamArg with SwaggerBodyParam with SwaggerStringParam with Product with Serializable

  116. case class StringForm(name: String, desc: String = "") extends SwaggerParamArg with SwaggerFormParam with SwaggerStringParam with Product with Serializable

  117. case class StringHeader(name: String, desc: String = "") extends SwaggerParamArg with SwaggerHeaderParam with SwaggerStringParam with Product with Serializable

  118. case class StringPath(name: String, desc: String = "") extends SwaggerParamArg with SwaggerPathParam with SwaggerStringParam with Product with Serializable

  119. case class StringQuery(name: String, desc: String = "") extends SwaggerParamArg with SwaggerQueryParam with SwaggerStringParam with Product with Serializable

  120. case class Summary(summary: String) extends SwaggerArg with Product with Serializable

  121. case class Tags(tags: String*) extends SwaggerArg with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. object Deprecated extends SwaggerArg with Product with Serializable

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  17. def toString(): String

    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped