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

sttp.apispec.openapi

package sttp.apispec.openapi

Members list

Concise view

Type members

Classlikes

final case class Callback(pathItems: ListMap[String, ReferenceOr[PathItem]])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Components(schemas: ListMap[String, ReferenceOr[SchemaLike]], responses: ListMap[String, ReferenceOr[Response]], parameters: ListMap[String, ReferenceOr[Parameter]], examples: ListMap[String, ReferenceOr[Example]], requestBodies: ListMap[String, ReferenceOr[RequestBody]], headers: ListMap[String, ReferenceOr[Header]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]], links: ListMap[String, ReferenceOr[Link]], callbacks: ListMap[String, ReferenceOr[Callback]], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Contact(name: Option[String], email: Option[String], url: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Contact.type
final case class Encoding(contentType: Option[String], headers: ListMap[String, ReferenceOr[Header]], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Example(summary: Option[String], description: Option[String], value: Option[ExampleValue], externalValue: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Example.type
final case class Header(description: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[ReferenceOr[SchemaLike]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Header.type
final case class Info(title: String, version: String, summary: Option[String], description: Option[String], termsOfService: Option[String], contact: Option[Contact], license: Option[License], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Link(operationRef: Option[String], operationId: Option[String], parameters: ListMap[String, String], requestBody: Option[String], description: Option[String], server: Option[Server], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Link.type
final case class MediaType(schema: Option[ReferenceOr[SchemaLike]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], encoding: ListMap[String, Encoding], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class OpenAPI(openapi: String, info: Info, jsonSchemaDialect: Option[String], tags: List[Tag], servers: List[Server], paths: Paths, webhooks: Option[Map[String, ReferenceOr[PathItem]]], components: Option[Components], security: List[SecurityRequirement], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Operation(tags: List[String], summary: Option[String], description: Option[String], externalDocs: Option[ExternalDocumentation], operationId: Option[String], parameters: List[ReferenceOr[Parameter]], requestBody: Option[ReferenceOr[RequestBody]], responses: Responses, callbacks: ListMap[String, ReferenceOr[Callback]], deprecated: Option[Boolean], security: List[SecurityRequirement], servers: List[Server], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Parameter(name: String, in: ParameterIn, description: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[ReferenceOr[SchemaLike]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Cookie.type
object Header.type
object Path.type
object Query.type
object ParameterIn

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class ParameterStyle(val value: String)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
final case class PathItem(ref: Option[Reference], summary: Option[String], description: Option[String], get: Option[Operation], put: Option[Operation], post: Option[Operation], delete: Option[Operation], options: Option[Operation], head: Option[Operation], patch: Option[Operation], trace: Option[Operation], servers: List[Server], parameters: List[ReferenceOr[Parameter]], extensions: ListMap[String, ExtensionValue])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Paths(pathItems: ListMap[String, PathItem], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Paths.type
final case class RequestBody(description: Option[String], content: ListMap[String, MediaType], required: Option[Boolean], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Response(description: String, headers: ListMap[String, ReferenceOr[Header]], content: ListMap[String, MediaType], links: ListMap[String, ReferenceOr[Link]], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Responses(responses: ListMap[ResponsesKey, ReferenceOr[Response]], extensions: ListMap[String, ExtensionValue])

Attributes

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

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResponsesCodeKey(code: Int) extends ResponsesKey

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case object ResponsesDefaultKey extends ResponsesKey

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
sealed trait ResponsesKey

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class ResponsesRangeKey(range: Int) extends ResponsesKey

Attributes

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

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ServerVariable(enum: Option[List[String]], default: String, description: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

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