ChunkedJsonEntities
Interpreter for the algebra.ChunkedJsonEntities algebra in the endpoints4s.openapi family.
Type members
Inherited classlikes
- Value parameters:
- entity
Contents of the callback message
- method
HTTP method used for the callback
- response
Expected response
- Inherited from:
- EndpointsWithCustomErrors
This object contains the options for how to encode coproduct JSON schemas.
This object contains the options for how to encode coproduct JSON schemas.
The following Scala coproduct is the candidate example. Each encoding option includes the schema that it would generate for that example.
sealed trait Pet
case class Cat(name: String) extends Pet
case class Lizard(lovesRocks: Boolean) extends Pet
- Inherited from:
- JsonSchemas
- Inherited from:
- EndpointsWithCustomErrors
- Value parameters:
- name
Name of the parameter
- required
Whether this parameter is required or not (MUST be true for path parameters)
- Inherited from:
- Urls
A query string parameter documentation description for type A
A query string parameter documentation description for type A
- Value parameters:
- encoder
JSON encoder for query string parameter value, primarily used for encoding of the parameter's default value. Result of the encoding is optional since the empty value of optional query string parameter should result in the empty encoded value.
- isRequired
Whether the query string parameter is required
- schema
Schema that corresponds to type
A
- Inherited from:
- Urls
- Inherited from:
- Requests
- Value parameters:
- content
Map that associates each possible content-type (e.g. “text/html”) with a
MediaType
description- documentation
Human readable documentation. Not optional because its required by openapi
- headers
Response headers documentation
- status
Response status code (e.g. OK or NotFound)
- Inherited from:
- Responses
- Value parameters:
- path
List of path segments. Left is a static segment, right is a path parameter
- queryParameters
Query string parameters
- Inherited from:
- Urls
- Value parameters:
- callbacks
Callbacks indexed by event name
- deprecated
Indicates whether this endpoint is deprecated or not
- description
Detailed description
- operationId
A unique identifier which identifies this operation
- summary
Short description
- tags
OpenAPI tags
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for Endpoint.
Extension methods for Endpoint.
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
- Inherited from:
- InvariantFunctorSyntax
Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.
Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.
- Inherited from:
- JsonSchemas
Implicit methods for values of type JsonSchema
Implicit methods for values of type JsonSchema
- Inherited from:
- JsonSchemas
- Inherited from:
- PartialInvariantFunctorSyntax
Implicit methods for values of type Record
Implicit methods for values of type Record
- Inherited from:
- JsonSchemas
Inherited types
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
- See also:
Swagger Documentation at https://swagger.io/docs/specification/callbacks/
- Inherited from:
- EndpointsWithCustomErrors
Errors in a request built by a client
Errors in a request built by a client
- Inherited from:
- Errors
Error raised by the business logic of a server
Error raised by the business logic of a server
- Inherited from:
- Errors
Value members
Concrete methods
- Definition Classes
- Definition Classes
Inherited methods
- Inherited from:
- JsonSchemas
Bad Request (400) response, with an entity of type ClientErrors
.
Bad Request (400) response, with an entity of type ClientErrors
.
- See also:
- Inherited from:
- Responses
- Definition Classes
- Inherited from:
- JsonSchemas
Format of the response entity carrying the client errors.
Format of the response entity carrying the client errors.
- Inherited from:
- Errors
Convert the ClientErrors type into the endpoints4s internal client error type
Convert the ClientErrors type into the endpoints4s internal client error type
- Inherited from:
- Errors
- Inherited from:
- Urls
Override this method to customize the strategy used to encode the JSON schema of coproducts. By default, it uses CoproductEncoding.OneOf.
Override this method to customize the strategy used to encode the JSON schema of coproducts. By default, it uses CoproductEncoding.OneOf.
- See also:
- Inherited from:
- JsonSchemas
Default discriminator field name for sum types.
Default discriminator field name for sum types.
It defaults to "type", but you can override it twofold:
- by overriding this field you can change default discriminator name algebra-wide
- by using
withDiscriminator
you can specify discriminator field name for specific sum type
- Inherited from:
- JsonSchemas
Helper method to perform DELETE request
Helper method to perform DELETE request
- Type parameters:
- HeadersP
Payload carried by headers
- UrlP
Payload carried by url
- Inherited from:
- Requests
- Definition Classes
- Inherited from:
- JsonSchemas
- Definition Classes
- Inherited from:
- JsonSchemas
Helper method to perform GET request
Helper method to perform GET request
- Type parameters:
- HeadersP
Payload carried by headers
- UrlP
Payload carried by url
- Inherited from:
- Requests
Convenient constructor for enumerations represented by int values.
Convenient constructor for enumerations represented by int values.
- Inherited from:
- JsonSchemas
Internal Server Error (500) response, with an entity of type ServerError
.
Internal Server Error (500) response, with an entity of type ServerError
.
- See also:
- Inherited from:
- Responses
Convert the endpoints4s internal client error type into the ClientErrors type
Convert the endpoints4s internal client error type into the ClientErrors type
- Inherited from:
- Errors
A schema for a statically known value.
A schema for a statically known value.
- Decoder interpreters first try to decode incoming values with the given
tpe
schema, and then check that it is equal to the givenvalue
, - Encoder interpreters always produce the given
value
, encoded according totpe
, - Documentation interpreters enrich the JSON schema with a
const
property documenting its only possible value (or anenum
property with a single item).
This is useful to model schemas of objects containing extra fields that are absent from their Scala representation. For example, here is a schema for a GeoJSON point:
case class Point(lon: Double, lat: Double)
val pointSchema = (
field("type")(literal("Point")) zip
field[(Double, Double)]("coordinates")
).xmap(Point.tupled)(p => (p.lon, p.lat))
- Inherited from:
- JsonSchemas
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
OK (200) Response with the given entity
OK (200) Response with the given entity
- Inherited from:
- Responses
- Value parameters:
- endpoints
The endpoints to generate the documentation for
- info
General information about the documentation to generate
- Returns:
An
OpenApi
instance for the given endpoint descriptions- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- JsonSchemas
The JSON schema of a coproduct that share the same parent type and thus can be widened to that parent type
The JSON schema of a coproduct that share the same parent type and thus can be widened to that parent type
- Inherited from:
- JsonSchemas
- Inherited from:
- JsonSchemas
Helper method to perform PATCH request
Helper method to perform POST request
- Inherited from:
- Urls
- Inherited from:
- Requests
- Inherited from:
- Responses
Format of the response entity carrying the server error.
Format of the response entity carrying the server error.
- Inherited from:
- Errors
Convert the ServerError type into the endpoints4s internal server error type
Convert the ServerError type into the endpoints4s internal server error type
- Inherited from:
- Errors
Convenient constructor for enumerations represented by string values.
Convenient constructor for enumerations represented by string values.
- Inherited from:
- JsonSchemas
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
- Inherited from:
- Errors
Convert the internal representation of a JSON schema into the public OpenAPI AST
Convert the internal representation of a JSON schema into the public OpenAPI AST
- Inherited from:
- JsonSchemas
- Inherited from:
- Urls
Turns a Response[A]
into a Response[Option[A]]
.
Turns a Response[A]
into a Response[Option[A]]
.
Interpreters represent None
with
an empty HTTP response whose status code is 404 (Not Found).
- Inherited from:
- Responses
Inherited fields
Response used by endpoints4s when decoding a request fails.
Response used by endpoints4s when decoding a request fails.
The provided implementation forwards to badRequest
.
- Inherited from:
- Errors
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
- Inherited from:
- Urls
Response used by endpoints4s when the business logic of an endpoint fails.
Response used by endpoints4s when the business logic of an endpoint fails.
The provided implementation forwards to internalServerError
- Inherited from:
- Errors
The JSON codecs used to produce some parts of the documentation.
The JSON codecs used to produce some parts of the documentation.
- Inherited from:
- JsonSchemas
Implicits
Inherited implicits
Extension methods for Endpoint.
Extension methods for Endpoint.
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
- Inherited from:
- InvariantFunctorSyntax
Implicit methods for values of type JsonSchema
Implicit methods for values of type JsonSchema
- Inherited from:
- JsonSchemas
- Inherited from:
- PartialInvariantFunctorSyntax
Implicit methods for values of type Record
Implicit methods for values of type Record
- Inherited from:
- JsonSchemas
- Inherited from:
- SemigroupalSyntax
- Inherited from:
- Urls
- Inherited from:
- Urls
- Inherited from:
- Urls
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas
- Inherited from:
- TuplesSchemas