Packages

package openapi

Interpreters producing an OpenAPI model of endpoints

Source
package.scala
Linear Supertypes
Content Hierarchy

Package Members

  1. package model

Type Members

  1. trait Assets extends algebra.Assets with EndpointsWithCustomErrors with StatusCodes

    Interpreter for algebra.Assets

  2. trait BasicAuthentication extends algebra.BasicAuthentication with EndpointsWithCustomErrors with StatusCodes

    Interpreter for endpoints4s.algebra.BasicAuthentication that produces OpenAPI documentation.

  3. trait BuiltInErrors extends algebra.BuiltInErrors

  4. trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors

    Interpreter for the algebra.ChunkedEntities algebra in the endpoints4s.openapi family.

  5. trait ChunkedJsonEntities extends algebra.ChunkedJsonEntities with ChunkedEntities with JsonEntitiesFromSchemas

    Interpreter for the algebra.ChunkedJsonEntities algebra in the endpoints4s.openapi family.

  6. trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

    Interpreter for algebra.Endpoints that produces an endpoints4s.openapi.model.OpenApi instance for endpoints, and uses algebra.BuiltInErrors to model client and server errors.

  7. trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Requests with Responses

    Interpreter for algebra.Endpoints that produces an endpoints4s.openapi.model.OpenApi instance for endpoints.

  8. trait Headers extends AnyRef

    Internal.

  9. trait JsonEntities extends algebra.JsonEntities with EndpointsWithCustomErrors

    Partial interpreter for algebra.JsonEntities.

    Partial interpreter for algebra.JsonEntities.

    This interpreter documents that entities have a JSON content type, but it can not document the schemas of these entities. See algebra.JsonEntitiesFromSchemas for this purpose.

  10. trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with EndpointsWithCustomErrors with JsonSchemas

    Interpreter for algebra.JsonEntitiesFromSchemas that produces a documentation of the JSON schemas.

  11. trait JsonSchemas extends algebra.JsonSchemas with TuplesSchemas

    An interpreter for endpoints4s.algebra.JsonSchemas that produces a JSON schema for a given algebraic data type description.

    An interpreter for endpoints4s.algebra.JsonSchemas that produces a JSON schema for a given algebraic data type description.

    The encoding of the schemas of sealed traits (obtained with the operation orElse or via generic derivation) can be configured by overriding JsonSchemas.coproductEncoding.

  12. trait Methods extends algebra.Methods

    Interpreter for endpoints4s.algebra.Methods

  13. trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

  14. trait Requests extends algebra.Requests with Urls with Methods with Headers

    Interpreter for algebra.Requests.

  15. trait Responses extends algebra.Responses with StatusCodes with Headers

    Interpreter for algebra.Responses

  16. trait StatusCodes extends algebra.StatusCodes

    Interpreter for endpoints4s.algebra.StatusCodes

  17. trait TuplesSchemas extends algebra.TuplesSchemas

  18. trait Urls extends algebra.Urls

    Interpreter for algebra.Urls

Inherited from AnyRef

Inherited from Any

Interpreters

Ungrouped