Packages

c

endpoints4s.openapi.Urls

DocumentedParameter

case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

name

Name of the parameter

required

Whether this parameter is required or not (MUST be true for path parameters)

Source
Urls.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentedParameter
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema)

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

Value Members

  1. val description: Option[String]
  2. val name: String
  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. val required: Boolean
  5. val schema: Schema