apispec-model
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
apispec-model/sttp.apispec

sttp.apispec

package sttp.apispec

Members list

Concise view

Type members

Classlikes

sealed trait AnySchema extends SchemaLike

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Anything.type
object Nothing.type
object AnySchema

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ArraySchemaType(value: List[BasicSchemaType]) extends SchemaType

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed abstract class BasicSchemaType(val value: String) extends SchemaType

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Array.type
object Boolean.type
object Integer.type
object Null.type
object Number.type
object Object.type
object String.type
case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ExampleMultipleValue(values: List[Any]) extends ExampleValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ExampleSingleValue(value: Any) extends ExampleValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait ExampleValue

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ExtensionValue(value: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ExternalDocumentation(url: String, description: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class OAuthFlow(authorizationUrl: Option[String], tokenUrl: Option[String], refreshUrl: Option[String], scopes: ListMap[String, String], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class OAuthFlows(`implicit`: Option[OAuthFlow], password: Option[OAuthFlow], clientCredentials: Option[OAuthFlow], authorizationCode: Option[OAuthFlow], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Pattern(value: String)

Attributes

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Reference($ref: String, summary: Option[String], description: Option[String])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Reference

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Schema($schema: Option[String], allOf: List[ReferenceOr[SchemaLike]], title: Option[String], required: List[String], `type`: Option[SchemaType], prefixItems: Option[List[ReferenceOr[SchemaLike]]], items: Option[ReferenceOr[SchemaLike]], contains: Option[ReferenceOr[SchemaLike]], properties: ListMap[String, ReferenceOr[SchemaLike]], patternProperties: ListMap[Pattern, ReferenceOr[SchemaLike]], description: Option[String], format: Option[String], default: Option[ExampleValue], nullable: Option[Boolean], readOnly: Option[Boolean], writeOnly: Option[Boolean], example: Option[ExampleValue], deprecated: Option[Boolean], oneOf: List[ReferenceOr[SchemaLike]], discriminator: Option[Discriminator], additionalProperties: Option[ReferenceOr[SchemaLike]], pattern: Option[Pattern], minLength: Option[Int], maxLength: Option[Int], minimum: Option[BigDecimal], exclusiveMinimum: Option[Boolean], maximum: Option[BigDecimal], exclusiveMaximum: Option[Boolean], minItems: Option[Int], maxItems: Option[Int], enum: Option[List[ExampleSingleValue]], not: Option[ReferenceOr[SchemaLike]], `if`: Option[ReferenceOr[SchemaLike]], `then`: Option[ReferenceOr[SchemaLike]], `else`: Option[ReferenceOr[SchemaLike]], $defs: Option[ListMap[String, SchemaLike]], extensions: ListMap[String, ExtensionValue]) extends SchemaLike

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Schema

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Schema.type
object SchemaFormat

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait SchemaLike

Algebraic data type for all possible schemas

Algebraic data type for all possible schemas

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AnySchema
object Anything.type
object Nothing.type
class Schema
sealed trait SchemaType

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Array.type
object Boolean.type
object Integer.type
object Null.type
object Number.type
object Object.type
object String.type
object SchemaType

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SecurityScheme(`type`: String, description: Option[String], name: Option[String], in: Option[String], scheme: Option[String], bearerFormat: Option[String], flows: Option[OAuthFlows], openIdConnectUrl: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Tag(name: String, description: Option[String], externalDocs: Option[ExternalDocumentation], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Types

type ReferenceOr[T] = Either[Reference, T]
type SecurityRequirement = ListMap[String, Vector[String]]
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL