model

Type Members

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

   

2. sealed trait In extends AnyRef

   

3. case class Info(title: String, version: String) extends Product with Serializable

   

4. case class MediaType(schema: Option[Schema]) extends Product with Serializable

   

5. case class OpenApi(info: Info, paths: Map[String, PathItem], components: Components) extends Product with Serializable

   
   See also

   https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md

6. trait OpenApiSchemas extends algebra.JsonSchemas

   

   Provides an implicit instance of JsonSchema[OpenApi] which can be interpreted by a proper JSON encoder (e.g., endpoints-json-schema-playjson) to produce a JSON document out of an OpenApi value.

7. case class Operation(summary: Option[String], description: Option[String], parameters: List[Parameter], requestBody: Option[RequestBody], responses: Map[String, Response], tags: List[String], security: List[SecurityRequirement]) extends Product with Serializable

   

8. case class Parameter(name: String, in: In, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

   

9. case class PathItem(operations: Map[String, Operation]) extends Product with Serializable

   

10. case class RequestBody(description: Option[String], content: Map[String, MediaType]) extends Product with Serializable

    

11. case class Response(description: String, content: Map[String, MediaType]) extends Product with Serializable

    

12. sealed trait Schema extends AnyRef

    

13. case class SecurityRequirement(name: String, scheme: SecurityScheme, scopes: List[String] = Nil) extends Product with Serializable

    

14. case class SecurityScheme(type: String, description: Option[String], name: Option[String], in: Option[String], scheme: Option[String], bearerFormat: Option[String]) extends Product with Serializable