apispec-model
API
Generated with
apispec-model/sttp.apispec

sttp.apispec

package sttp.apispec

Members list

Packages

package sttp.apispec.validation

Type members

Classlikes

sealed trait AnySchema extends SchemaLike

Attributes

Companion
object
Supertypes
trait SchemaLike
class Object
trait Matchable
class Any
Known subtypes
object Anything
object Nothing
object AnySchema

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
AnySchema.type
case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]])

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ExampleValue
class Object
trait Matchable
class Any
Show all
sealed trait ExampleValue

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Schema($schema: Option[String], $vocabulary: Option[ListMap[String, Boolean]], $id: Option[String], $anchor: Option[String], $dynamicAnchor: Option[String], $ref: Option[String], $dynamicRef: Option[String], $comment: Option[String], $defs: Option[ListMap[String, SchemaLike]], title: Option[String], description: Option[String], default: Option[ExampleValue], deprecated: Option[Boolean], readOnly: Option[Boolean], writeOnly: Option[Boolean], examples: Option[List[ExampleValue]], `type`: Option[List[SchemaType]], enum: Option[List[ExampleValue]], const: Option[ExampleValue], format: Option[String], allOf: List[SchemaLike], anyOf: List[SchemaLike], oneOf: List[SchemaLike], not: Option[SchemaLike], `if`: Option[SchemaLike], `then`: Option[SchemaLike], `else`: Option[SchemaLike], dependentSchemas: ListMap[String, SchemaLike], multipleOf: Option[BigDecimal], minimum: Option[BigDecimal], exclusiveMinimum: Option[BigDecimal], maximum: Option[BigDecimal], exclusiveMaximum: Option[BigDecimal], maxLength: Option[Int], minLength: Option[Int], pattern: Option[Pattern], maxItems: Option[Int], minItems: Option[Int], uniqueItems: Option[Boolean], maxContains: Option[Int], minContains: Option[Int], prefixItems: Option[List[SchemaLike]], items: Option[SchemaLike], contains: Option[SchemaLike], unevaluatedItems: Option[SchemaLike], maxProperties: Option[Int], minProperties: Option[Int], required: List[String], dependentRequired: ListMap[String, List[String]], discriminator: Option[Discriminator], properties: ListMap[String, SchemaLike], patternProperties: ListMap[Pattern, SchemaLike], additionalProperties: Option[SchemaLike], propertyNames: Option[SchemaLike], unevaluatedProperties: Option[SchemaLike], externalDocs: Option[ExternalDocumentation], extensions: ListMap[String, ExtensionValue]) extends SchemaLike

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait SchemaLike
class Object
trait Matchable
class Any
Show all
object Schema

Attributes

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

Attributes

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

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AnySchema
object Anything
object Nothing
class Schema
sealed abstract class SchemaType(val value: String)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Array
object Boolean
object Integer
object Null
object Number
object Object
object String
Show all
object SchemaType

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SchemaType.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

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type SecurityRequirement = ListMap[String, Vector[String]]
Generated with