sttp.apispec.openapi
package sttp.apispec.openapi
Members list
Type members
Classlikes
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Callback
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Components
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Components.type
final case class Contact(name: Option[String], email: Option[String], url: Option[String], extensions: ListMap[String, ExtensionValue])
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Contact
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Encoding
final case class Example(summary: Option[String], description: Option[String], value: Option[ExampleValue], externalValue: Option[String], extensions: ListMap[String, ExtensionValue])
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Example
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Header
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
final case class License(name: String, url: Option[String], extensions: ListMap[String, ExtensionValue])
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Link
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object MediaType
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Operation
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object ParameterIn
Attributes
- Companion
- class
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ParameterIn.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object DeepObject.typeobject Form.typeobject Label.typeobject Matrix.typeobject PipeDelimited.typeobject Simple.typeobject SpaceDelimited.typeShow all
object ParameterStyle extends Enumeration
Attributes
- Companion
- class
- Supertypes
-
trait Sumtrait Mirrorclass Enumerationtrait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
ParameterStyle.type
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
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Paths
final case class RequestBody(description: Option[String], content: ListMap[String, MediaType], required: Option[Boolean], extensions: ListMap[String, ExtensionValue])
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object RequestBody
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RequestBody.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Response
final case class Responses(responses: ListMap[ResponsesKey, ReferenceOr[Response]], extensions: ListMap[String, ExtensionValue])
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Responses
final case class ResponsesCodeKey(code: Int) extends ResponsesKey
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait ResponsesKeyclass Objecttrait Matchableclass AnyShow all
case object ResponsesDefaultKey extends ResponsesKey
Attributes
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait ResponsesKeyclass Objecttrait Matchableclass AnyShow all
- Self type
-
ResponsesDefaultKey.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
final case class ResponsesRangeKey(range: Int) extends ResponsesKey
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait ResponsesKeyclass Objecttrait Matchableclass AnyShow all
final case class Server(url: String, description: Option[String], variables: Option[ListMap[String, ServerVariable]], extensions: ListMap[String, ExtensionValue])
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
final case class ServerVariable(enum: Option[List[String]], default: String, description: Option[String], extensions: ListMap[String, ExtensionValue])
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
In this article