openapi

Type Members

1. case class Components(schemas: ListMap[String, ReferenceOr[Schema]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]]) extends Product with Serializable

   

2. case class Contact(name: Option[String], email: Option[String], url: Option[String]) extends Product with Serializable

   

3. case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]]) extends Product with Serializable

   

4. case class Encoding(contentType: Option[String], headers: ListMap[String, ReferenceOr[Header]], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean]) extends Product with Serializable

   

5. case class Example(summary: Option[String], description: Option[String], value: Option[ExampleValue], externalValue: Option[String]) extends Product with Serializable

   

6. case class ExampleValue(value: String) extends Product with Serializable

   

7. case class ExternalDocumentation(url: String, description: Option[String] = None) extends Product with Serializable

   

8. 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[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType]) extends Product with Serializable

   

9. case class Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[Contact] = None, license: Option[License] = None) extends Product with Serializable

   

10. implicit class IterableToListMap[A] extends AnyRef

    

11. case class License(name: String, url: Option[String]) extends Product with Serializable

    

12. case class MediaType(schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], encoding: ListMap[String, Encoding]) extends Product with Serializable

    

13. case class OAuthFlow(authorizationUrl: String, tokenUrl: String, refreshUrl: Option[String], scopes: ListMap[String, String]) extends Product with Serializable

    

14. case class OAuthFlows(implicit: Option[OAuthFlow] = None, password: Option[OAuthFlow] = None, clientCredentials: Option[OAuthFlow] = None, authorizationCode: Option[OAuthFlow] = None) extends Product with Serializable

    

15. case class OpenAPI(openapi: String = "3.0.1", info: Info, tags: List[Tag], servers: List[Server], paths: ListMap[String, PathItem], components: Option[Components], security: List[SecurityRequirement]) extends Product with Serializable

    

16. case class Operation(tags: List[String], summary: Option[String], description: Option[String], operationId: String, parameters: List[ReferenceOr[Parameter]], requestBody: Option[ReferenceOr[RequestBody]], responses: ListMap[ResponsesKey, ReferenceOr[Response]], deprecated: Option[Boolean], security: List[SecurityRequirement], servers: List[Server]) extends Product with Serializable

    

17. 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: ReferenceOr[Schema], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType]) extends Product with Serializable

    

18. case class PathItem(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]]) extends Product with Serializable

    

19. case class Reference($ref: String) extends Product with Serializable

    

20. case class RequestBody(description: Option[String], content: ListMap[String, MediaType], required: Option[Boolean]) extends Product with Serializable

    

21. case class Response(description: String, headers: ListMap[String, ReferenceOr[Header]], content: ListMap[String, MediaType]) extends Product with Serializable

    

22. case class ResponsesCodeKey(code: Int) extends ResponsesKey with Product with Serializable

    

23. sealed trait ResponsesKey extends AnyRef

    

24. case class Schema(title: Option[String], required: List[String], type: Option[SchemaType], items: Option[ReferenceOr[Schema]], properties: ListMap[String, ReferenceOr[Schema]], description: Option[String], format: Option[SchemaFormat], default: Option[ExampleValue], nullable: Option[Boolean], readOnly: Option[Boolean], writeOnly: Option[Boolean], example: Option[ExampleValue], deprecated: Option[Boolean], oneOf: Option[List[ReferenceOr[Schema]]], discriminator: Option[Discriminator]) extends Product with Serializable

    

25. 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]) extends Product with Serializable

    

26. case class Server(url: String, description: Option[String]) extends Product with Serializable

    

27. case class Tag(name: String, description: Option[String] = None, externalDocs: Option[ExternalDocumentation] = None) extends Product with Serializable