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

Schema

sttp.apispec.Schema
See theSchema companion object
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
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait SchemaLike
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def nullable: Schema

Returns a Schema that allows null values in addition to the current schema. The implementation is idempotent, i.e. schema.nullable.nullable == schema.nullable.

Returns a Schema that allows null values in addition to the current schema. The implementation is idempotent, i.e. schema.nullable.nullable == schema.nullable.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with