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

automorph.schema.openrpc

package automorph.schema.openrpc

Members list

Type members

Classlikes

case class Components(contentDescriptors: Option[Map[String, ContentDescriptor]], schemas: Option[Map[String, Schema]], examples: Option[Map[String, Example]], links: Option[Map[String, Link]], error: Option[Map[String, Error]], examplePairingObjects: Option[Map[String, ExamplePairing]], tags: Option[Map[String, Tag]])

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 ContentDescriptor(name: String, summary: Option[String], description: Option[String], required: Option[Boolean], schema: Schema, deprecated: 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 Error(code: Int, message: String, data: 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 Example(name: Option[String], 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 ExamplePairing(name: String, summary: Option[String], description: Option[String], params: List[Example], result: Option[Example])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
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 Info(title: 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, url: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Link(name: String, summary: Option[String], description: Option[String], method: Option[String], params: Option[Map[String, 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 Method(name: String, tags: Option[List[Tag]], summary: Option[String], description: Option[String], externalDocs: Option[ExternalDocumentation], params: List[ContentDescriptor], result: Option[ContentDescriptor], deprecated: Option[Boolean], servers: Option[List[Server]], errors: Option[List[Error]], links: Option[List[Link]], paramStructure: Option[String], examples: Option[List[ExamplePairing]], $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 Error
class Example
class Link
class Method
class Tag
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
case object Schema

Attributes

Companion
class
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Schema.type
final case class Server(name: String, url: String, summary: Option[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, summary: Option[String], description: Option[String], externalDocs: Option[ExternalDocumentation], $ref: Option[String]) extends Reference

Attributes

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