sttp.apispec
package sttp.apispec
Type members
Classlikes
case class ExternalDocumentation(url: String, description: Option[String], extensions: ListMap[String, ExtensionValue])
case class OAuthFlow(authorizationUrl: Option[String], tokenUrl: Option[String], refreshUrl: Option[String], scopes: ListMap[String, String], extensions: ListMap[String, ExtensionValue])
case class OAuthFlows(`implicit`: Option[OAuthFlow], password: Option[OAuthFlow], clientCredentials: Option[OAuthFlow], authorizationCode: Option[OAuthFlow], extensions: ListMap[String, ExtensionValue])
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
- Companion:
- object
Algebraic data type for all possible schemas
Algebraic data type for all possible schemas
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])
case class Tag(name: String, description: Option[String], externalDocs: Option[ExternalDocumentation], extensions: ListMap[String, ExtensionValue])