endpoints.documented

openapi

package openapi

Visibility
  1. Public
  2. All

Type Members

  1. trait Assets extends algebra.Assets with Endpoints

    Interpreter for algebra.Assets

  2. trait BasicAuthentication extends algebra.BasicAuthentication with Endpoints

    Interpreter for algebra.BasicAuthentication that produces OpenAPI documentation.

  3. trait Endpoints extends algebra.Endpoints with Requests with Responses

    Interpreter for algebra.Endpoints that produces an OpenApi instance for endpoints.

  4. sealed trait In extends AnyRef

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

  6. trait JsonEntities extends algebra.JsonEntities with Endpoints

    Partial interpreter for algebra.JsonEntities.

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

  8. trait Methods extends algebra.Methods

    Interpreter for endpoints.algebra.Methods

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

  10. case class Operation(parameters: List[Parameter], requestBody: Option[RequestBody], responses: Map[Int, Response]) extends Product with Serializable

  11. trait OptionalResponses extends algebra.OptionalResponses with Endpoints

    Interpreter for algebra.OptionalResponses

  12. case class Parameter(name: String, in: In, required: Boolean) extends Product with Serializable

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

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

  15. trait Requests extends algebra.Requests with Urls with Methods

    Interpreter for algebra.Requests.

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

  17. trait Responses extends algebra.Responses

    Interpreter for algebra.Responses

  18. sealed trait Schema extends AnyRef

  19. trait Urls extends algebra.Urls

    Interpreter for algebra.Urls

Value Members

  1. object In

  2. object MediaType extends Serializable

  3. object OpenApi extends Serializable

  4. object Operation extends Serializable

  5. object Parameter extends Serializable

  6. object PathItem extends Serializable

  7. object RequestBody extends Serializable

Ungrouped