package openapi
Interpreters producing an OpenAPI model of endpoints
- Source
- package.scala
Type Members
- trait Assets extends algebra.Assets with EndpointsWithCustomErrors with StatusCodes
Interpreter for algebra.Assets
- trait BasicAuthentication extends algebra.BasicAuthentication with EndpointsWithCustomErrors with StatusCodes
Interpreter for endpoints4s.algebra.BasicAuthentication that produces OpenAPI documentation.
- trait BuiltInErrors extends algebra.BuiltInErrors
- trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors
Interpreter for the algebra.ChunkedEntities algebra in the endpoints4s.openapi family.
- trait ChunkedJsonEntities extends algebra.ChunkedJsonEntities with ChunkedEntities with JsonEntitiesFromSchemas
Interpreter for the algebra.ChunkedJsonEntities algebra in the endpoints4s.openapi family.
- 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.
- trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Requests with Responses
Interpreter for algebra.Endpoints that produces an endpoints4s.openapi.model.OpenApi instance for endpoints.
- trait Headers extends AnyRef
Internal.
- 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.
- trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with EndpointsWithCustomErrors with JsonSchemas
Interpreter for algebra.JsonEntitiesFromSchemas that produces a documentation of the JSON schemas.
- 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. - trait Methods extends algebra.Methods
Interpreter for endpoints4s.algebra.Methods
- trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors
- trait Requests extends algebra.Requests with Urls with Methods with Headers
Interpreter for algebra.Requests.
- trait Responses extends algebra.Responses with StatusCodes with Headers
Interpreter for algebra.Responses
- trait StatusCodes extends algebra.StatusCodes
Interpreter for endpoints4s.algebra.StatusCodes
- trait TuplesSchemas extends algebra.TuplesSchemas
- trait Urls extends algebra.Urls
Interpreter for algebra.Urls