Automorph
API
Generated with
Automorph/automorph/automorph.schema/automorph.schema.openapi

automorph.schema.openapi

package automorph.schema.openapi

Members list

Type members

Classlikes

final case class Components(schemas: Option[Map[String, Schema]], responses: Option[Map[String, Response]], parameters: Option[Map[String, Parameter]], examples: Option[Map[String, Example]], requestBodies: Option[Map[String, RequestBody]], headers: Option[Map[String, Header]], securitySchemes: Option[Map[String, SecurityScheme]], links: Option[Map[String, Link]], callbacks: Option[Map[String, Callback]], pathItems: Option[Map[String, PathItem]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Contact(name: Option[String], url: Option[String], email: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Encoding(contentType: Option[String], headers: Option[Map[String, HeaderReference]], style: Option[String], explode: Option[Boolean], allowReserved: Option[Boolean])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Example(summary: Option[String], description: Option[String], value: Option[String], externalValue: Option[String], $ref: Option[String]) extends Reference

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Header(descriptipon: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[String], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[Schema], example: Option[String], examples: Option[Map[String, Example]], content: Option[Map[String, MediaType]], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class HeaderReference($ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class Info(title: String, summary: Option[String], description: Option[String], termsOfService: Option[String], contact: Option[Contact], license: Option[License], version: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class License(name: String, identifier: Option[String], url: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Link(operationRef: Option[String], operationId: Option[String], parameters: Option[Map[String, String]], requestBody: Option[String], description: Option[String], server: Option[Server], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class MediaType(schema: Option[Schema], example: Option[String], examples: Option[Map[String, Example]], encoding: Option[Map[String, Encoding]])

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Operation.type
final case class Parameter(name: String, in: String, descriptipon: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[String], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[Schema], example: Option[String], examples: Option[Map[String, Example]], content: Option[Map[String, MediaType]], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class PathItem($ref: Option[String], 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: Option[List[Server]], parameters: Option[List[Parameter]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class PathItemReference($ref: Option[String]) extends Reference

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Example
class Header
class Link
class Parameter
class RequestBody
class Response
Show all
final case class RequestBody(description: Option[String], content: Map[String, MediaType], required: Option[Boolean], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class Response(description: String, headers: Option[Map[String, Header]], content: Option[Map[String, MediaType]], links: Option[Map[String, Link]], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class RpcSchema(request: Schema, result: Schema, error: Schema)

RPC function schema.

RPC function schema.

Value parameters

error

error schema

request

request schema

result

result schema

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Schema(`type`: Option[String], title: Option[String], description: Option[String], properties: Option[Properties], required: Option[List[String]], default: Option[String], allOf: Option[List[Schema]], $ref: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
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
final 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], $ref: Option[String]) extends Reference

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reference
class Object
trait Matchable
class Any
Show all
final case class Server(url: String, description: Option[String], variables: Option[Map[String, ServerVariable]])

Attributes

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

Attributes

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

Attributes

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