Packages

t

endpoints4s.openapi

BasicAuthentication

trait BasicAuthentication extends algebra.BasicAuthentication with EndpointsWithCustomErrors with StatusCodes

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

Source
BasicAuthentication.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BasicAuthentication
  2. EndpointsWithCustomErrors
  3. Responses
  4. StatusCodes
  5. Requests
  6. Headers
  7. Methods
  8. Urls
  9. BasicAuthentication
  10. EndpointsWithCustomErrors
  11. Errors
  12. Responses
  13. StatusCodes
  14. Requests
  15. SemigroupalSyntax
  16. Methods
  17. Urls
  18. PartialInvariantFunctorSyntax
  19. InvariantFunctorSyntax
  20. AnyRef
  21. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    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.

    Definition Classes
    InvariantFunctorSyntax
  2. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
  3. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  4. final class CallbackDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  5. final class EndpointDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  7. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

    Definition Classes
    Responses
  8. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

    Convenient methods for Paths.

    Definition Classes
    Urls
  9. implicit class QueryStringSyntax[A] extends AnyRef

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls
  10. type CallbacksDocs = Map[String, CallbackDocs]

    Callbacks indexed by URL pattern

    Callbacks indexed by URL pattern

    Definition Classes
    EndpointsWithCustomErrors
    See also

    Swagger Documentation at https://swagger.io/docs/specification/callbacks/

  11. abstract type ClientErrors

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    Errors
  12. type Endpoint[A, B] = DocumentedEndpoint

    Information carried by an HTTP endpoint

    Information carried by an HTTP endpoint

    Values of type Endpoint can be constructed by using the operation endpoint.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  13. type Path[A] = DocumentedUrl

    An URL path carrying an A information

    An URL path carrying an A information

    Values of type Path[A] can be constructed by the operations path, segment, and remainingSegments.

    path / "user" / segment[UUID]("id")
    • Server interpreters raise an error if they can’t parse the incoming request path as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

  14. type QueryString[A] = DocumentedQueryString

    A query string carrying an A information

    A query string carrying an A information

    QueryString values can be created with the qs operation, and can be combined with the & operation:

    val queryPageAndLang: QueryString[(Int, Option[String])] =
      qs[Int]("page") & qs[Option[String]]("lang")
    • Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

  15. type QueryStringParam[A] = DocumentedQueryStringParam

    A query string parameter codec for type A.

    A query string parameter codec for type A.

    The trait Urls provides implicit instances of type QueryStringParam[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

  16. type Request[A] = DocumentedRequest

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

    • Server interpreters raise an error if they can’t parse the incoming request as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    RequestsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax class.

  17. type RequestEntity[A] = Map[String, MediaType]

    Information carried by request entity

    Information carried by request entity

    Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    • Server interpreters raise an error if they can’t parse the incoming request entity as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    RequestsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.

  18. type RequestHeaders[A] = DocumentedHeaders

    Information carried by requests’ headers.

    Information carried by requests’ headers.

    You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.

    • Server interpreters raise an error if they can’t parse the incoming request headers as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    RequestsRequests
    Note

    This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.

  19. type Response[A] = List[DocumentedResponse]

    An HTTP response (status, headers, and entity) carrying an information of type A

    An HTTP response (status, headers, and entity) carrying an information of type A

    Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes

  20. type ResponseEntity[A] = Map[String, MediaType]

    An HTTP response entity carrying an information of type A

    An HTTP response entity carrying an information of type A

    Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  21. type ResponseHeaders[A] = DocumentedHeaders

    Information carried by responses’ headers.

    Information carried by responses’ headers.

    You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.

  22. type Segment[A] = Schema

    An URL path segment codec for type A.

    An URL path segment codec for type A.

    The trait Urls provides implicit instances of Segment[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

  23. abstract type ServerError

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    Errors
  24. type StatusCode = Int

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  25. type Url[A] = DocumentedUrl

    An URL carrying an A information

    An URL carrying an A information

    Values of type URL[A] are typically constructed by first using the path constructor and then chaining it with segments and query parameters.

    path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
    • Server interpreters raise an error if they can’t parse the incoming request URL as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.

  26. case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable

    path

    Path template (e.g. “/user/{id}”)

    item

    Item documentation

    Definition Classes
    EndpointsWithCustomErrors
  27. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Headers
  28. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

    List of request header names (e.g. “Authorization”)

    Definition Classes
    Headers
  29. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  30. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: Requests.DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
    Definition Classes
    Requests
  31. case class DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, headers: (Responses.this)#DocumentedHeaders, content: Map[String, MediaType]) extends Product with Serializable

    status

    Response status code (e.g. OK or NotFound)

    documentation

    Human readable documentation. Not optional because its required by openapi

    headers

    Response headers documentation

    content

    Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

    Definition Classes
    Responses
  32. case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

    Definition Classes
    Urls
  33. case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

    parameters

    List of query string parameters

    Definition Classes
    Urls
  34. case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
    Definition Classes
    Urls
  35. case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter]) extends Product with Serializable

    path

    List of path segments. Left is a static segment, right is a path parameter

    queryParameters

    Query string parameters

    Definition Classes
    Urls

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]

    Format of the response entity carrying the client errors.

    Format of the response entity carrying the client errors.

    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

    Convert the ClientErrors type into the endpoints4s internal client error type

    Convert the ClientErrors type into the endpoints4s internal client error type

    Definition Classes
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors

    Convert the endpoints4s internal client error type into the ClientErrors type

    Convert the endpoints4s internal client error type into the ClientErrors type

    Definition Classes
    Errors
  4. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]

    Format of the response entity carrying the server error.

    Format of the response entity carrying the server error.

    Definition Classes
    Errors
  5. abstract def serverErrorToThrowable(serverError: ServerError): Throwable

    Convert the ServerError type into the endpoints4s internal server error type

    Convert the ServerError type into the endpoints4s internal server error type

    Definition Classes
    Errors
  6. abstract def throwableToServerError(throwable: Throwable): ServerError

    Convert the endpoints4s internal server error type into the ServerError type

    Convert the endpoints4s internal server error type into the ServerError type

    Definition Classes
    Errors

Concrete Value Members

  1. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toany2stringadd[BasicAuthentication] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  6. def ->[B](y: B): (BasicAuthentication, B)
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toArrowAssoc[BasicAuthentication] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def Accepted: Int

    Definition Classes
    StatusCodesStatusCodes
  9. def AlreadyReported: Int

    Definition Classes
    StatusCodesStatusCodes
  10. def BadRequest: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  11. def Conflict: Int

    Definition Classes
    StatusCodesStatusCodes
  12. def Created: Int

    Definition Classes
    StatusCodesStatusCodes
  13. def ExpectationFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  14. def FailedDependency: Int

    Definition Classes
    StatusCodesStatusCodes
  15. def Forbidden: Int

    Definition Classes
    StatusCodesStatusCodes
  16. def Gone: Int

    Definition Classes
    StatusCodesStatusCodes
  17. def IMUsed: Int

    Definition Classes
    StatusCodesStatusCodes
  18. def InternalServerError: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  19. def LengthRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  20. def Locked: Int

    Definition Classes
    StatusCodesStatusCodes
  21. def MethodNotAllowed: Int

    Definition Classes
    StatusCodesStatusCodes
  22. def MisdirectedRequest: Int

    Definition Classes
    StatusCodesStatusCodes
  23. def MultiStatus: Int

    Definition Classes
    StatusCodesStatusCodes
  24. def NoContent: Int

    Definition Classes
    StatusCodesStatusCodes
  25. def NonAuthoritativeInformation: Int

    Definition Classes
    StatusCodesStatusCodes
  26. def NotAcceptable: Int

    Definition Classes
    StatusCodesStatusCodes
  27. def NotFound: Int

    Definition Classes
    StatusCodesStatusCodes
  28. def NotImplemented: Int

    Definition Classes
    StatusCodesStatusCodes
  29. def NotModified: Int

    Definition Classes
    StatusCodesStatusCodes
  30. def OK: Int

    Definition Classes
    StatusCodesStatusCodes
  31. def PartialContent: Int

    Definition Classes
    StatusCodesStatusCodes
  32. def PayloadTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  33. def PaymentRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  34. def PreconditionFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  35. def PreconditionRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  36. def ProxyAuthenticationRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  37. def RangeNotSatisfiable: Int

    Definition Classes
    StatusCodesStatusCodes
  38. def RequestHeaderFieldsTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  39. def RequestTimeout: Int

    Definition Classes
    StatusCodesStatusCodes
  40. def ResetContent: Int

    Definition Classes
    StatusCodesStatusCodes
  41. def TooEarly: Int

    Definition Classes
    StatusCodesStatusCodes
  42. def TooManyRequests: Int

    Definition Classes
    StatusCodesStatusCodes
  43. def Unauthorized: Int

    Definition Classes
    StatusCodesStatusCodes
  44. def UnavailableForLegalReasons: Int

    Definition Classes
    StatusCodesStatusCodes
  45. def UnprocessableEntity: Int

    Definition Classes
    StatusCodesStatusCodes
  46. def UnsupportedMediaType: Int

    Definition Classes
    StatusCodesStatusCodes
  47. def UpgradeRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  48. def UriTooLong: Int

    Definition Classes
    StatusCodesStatusCodes
  49. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  50. def authenticatedEndpoint[U, E, R, H, UE, HCred, Out](method: Method, url: Url[U], response: Response[R], requestEntity: RequestEntity[E] = emptyRequest, requestHeaders: RequestHeaders[H] = emptyRequestHeaders, unauthenticatedDocs: Documentation = None, requestDocs: Documentation = None, endpointDocs: EndpointDocs = EndpointDocs())(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerHCred: Tupler.Aux[H, Credentials, HCred], tuplerUEHCred: Tupler.Aux[UE, HCred, Out]): Endpoint[Out, Option[R]]

    Describes an endpoint protected by Basic HTTP authentication

    Describes an endpoint protected by Basic HTTP authentication

    Definition Classes
    BasicAuthenticationBasicAuthentication
  51. final def badRequest[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]

    Bad Request (400) response, with an entity of type ClientErrors.

    Bad Request (400) response, with an entity of type ClientErrors.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  52. def basicAuthenticationSchemeName: String
  53. def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    UrlsUrls
  54. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

    Chains the two paths

    Definition Classes
    UrlsUrls
  55. def choiceRequestEntity[A, B](requestEntityA: Map[String, MediaType], requestEntityB: Map[String, MediaType]): Map[String, MediaType]

    Alternative between two possible request entities, differentiated by the Content-Type header

    Alternative between two possible request entities, differentiated by the Content-Type header

    Definition Classes
    RequestsRequests
    Note

    If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead

    • Server interpreters accept either of the request entities
    • Client interpreters provide one of the two request entities
    • Documentation interpreters list all possible content types and their entities
  56. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

    Alternative between two possible choices of responses.

    Alternative between two possible choices of responses.

    Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.

    Definition Classes
    ResponsesResponses
  57. lazy val clientErrorsResponse: Response[ClientErrors]

    Response used by endpoints4s when decoding a request fails.

    Response used by endpoints4s when decoding a request fails.

    The provided implementation forwards to badRequest.

    Definition Classes
    Errors
  58. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  59. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    UrlsUrls
  60. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform DELETE request

    Helper method to perform DELETE request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  61. def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

    Definition Classes
    UrlsUrls
  62. def doubleSegment: Segment[Double]

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    UrlsUrls
  63. lazy val emptyRequest: Map[String, MediaType]

    Empty request -- request without a body.

    Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

    Definition Classes
    RequestsRequests
  64. def emptyRequestHeaders: DocumentedHeaders

    Ignore headers

    Ignore headers

    • Server interpreters don’t try to parse any information from the request headers,
    • Client interpreters supply no specific headers

    Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

    Definition Classes
    RequestsRequests
  65. def emptyResponse: ResponseEntity[Unit]

    Empty response entity

    Empty response entity

    • Server interpreters produce no response entity,
    • Client interpreters ignore the response entity.
    Definition Classes
    ResponsesResponses
  66. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    ResponsesResponses
  67. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]

    Define an HTTP endpoint

    Define an HTTP endpoint

    request

    Request

    response

    Response

    docs

    Documentation (used by documentation interpreters)

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  68. def ensuring(cond: (BasicAuthentication) => Boolean, msg: => Any): BasicAuthentication
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toEnsuring[BasicAuthentication] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  69. def ensuring(cond: (BasicAuthentication) => Boolean): BasicAuthentication
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toEnsuring[BasicAuthentication] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  70. def ensuring(cond: Boolean, msg: => Any): BasicAuthentication
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toEnsuring[BasicAuthentication] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  71. def ensuring(cond: Boolean): BasicAuthentication
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toEnsuring[BasicAuthentication] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  72. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  74. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toStringFormat[BasicAuthentication] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  75. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform GET request

    Helper method to perform GET request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  76. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  78. def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    UrlsUrls
  79. def intSegment: Segment[Int]

    Path segment codec for type Int

    Path segment codec for type Int

    Definition Classes
    UrlsUrls
  80. final def internalServerError[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]

    Internal Server Error (500) response, with an entity of type ServerError.

    Internal Server Error (500) response, with an entity of type ServerError.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  81. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  82. def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    UrlsUrls
  83. def longSegment: Segment[Long]

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    UrlsUrls
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  87. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    OK (200) Response with the given entity

    OK (200) Response with the given entity

    Definition Classes
    Responses
  88. def openApi(info: Info)(endpoints: DocumentedEndpoint*): OpenApi

    info

    General information about the documentation to generate

    endpoints

    The endpoints to generate the documentation for

    returns

    An OpenApi instance for the given endpoint descriptions

    Definition Classes
    EndpointsWithCustomErrors
  89. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

    An optional request header

    An optional request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    RequestsRequests
  90. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]

    Response headers optionally containing a header with the given name.

    Response headers optionally containing a header with the given name.

    • Client interpreters should model the header value as Some[String], or None if the response header is missing.
    • Server interpreters should produce such a response header.
    • Documentation interpreters should document this header.
    Definition Classes
    ResponsesResponses
  91. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Make a query string parameter optional:

    Make a query string parameter optional:

    path / "articles" /? qs[Option[Int]]("page")
    • Client interpreters must omit optional query string parameters that are empty.
    • Server interpreters must accept incoming requests whose optional query string parameters are missing, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
    • Documentation interpreters should mark the parameter as optional.
    Definition Classes
    UrlsUrls
  92. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PATCH request

    Helper method to perform PATCH request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  93. val path: Path[Unit]

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int] /? qs[String]("bar")
    Definition Classes
    Urls
  94. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  95. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform POST request

    Helper method to perform POST request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  96. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PUT request

    Helper method to perform PUT request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    Definition Classes
    Requests
  97. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

    Builds a QueryString with one parameter.

    Builds a QueryString with one parameter.

    Examples:

    qs[Int]("page")            // mandatory `page` parameter
    qs[Option[String]]("lang") // optional `lang` parameter
    qs[List[Long]]("id")       // repeated `id` parameter
    A

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  98. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  99. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  100. def remainingSegments(name: String, docs: Documentation): Path[String]

    The remaining segments of the path.

    The remaining segments of the path. The String value carried by this Path is still URL-encoded.

    Definition Classes
    UrlsUrls
  101. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Support query string parameters with multiple values:

    Support query string parameters with multiple values:

    path / "articles" /? qs[List[Long]]("id")
    • Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
    Definition Classes
    UrlsUrls
  102. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyRequestHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Request for given parameters

    Request for given parameters

    method

    Request method

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    RequestsRequests
  103. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  104. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

    A required request header

    A required request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    RequestsRequests
  105. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  106. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    RequestsRequests
    See also

    SemigroupalSyntax

  107. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  108. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    Define an HTTP response

    Define an HTTP response

    • Server interpreters construct a response with the given status and entity.
    • Client interpreters accept a response only if it has a corresponding status code.
    statusCode

    Response status code

    entity

    Response entity

    docs

    Response documentation

    headers

    Response headers

    Definition Classes
    ResponsesResponses
  109. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    ResponsesResponses
  110. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]

    Response headers containing a header with the given name.

    Response headers containing a header with the given name.

    • Client interpreters should model the header value as String, or fail if the response header is missing.
    • Server interpreters should produce such a response header.
    • Documentation interpreters should document this header.

    Example:

    val versionedResource: Endpoint[Unit, (SomeResource, String)] =
      endpoint(
        get(path / "versioned-resource"),
        ok(
          jsonResponse[SomeResource],
          headers = responseHeader("ETag")
        )
      )
    Definition Classes
    ResponsesResponses
  111. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    ResponsesResponses
    See also

    InvariantFunctorSyntax

  112. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    ResponsesResponses
    See also

    SemigroupalSyntax

  113. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]

    Provides the operation xmap to the type Response

    Provides the operation xmap to the type Response

    Definition Classes
    ResponsesResponses
    See also

    InvariantFunctorSyntax

  114. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]

    A path segment carrying an A information

    A path segment carrying an A information

    Definition Classes
    UrlsUrls
  115. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  116. lazy val serverErrorResponse: Response[ServerError]

    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

    Definition Classes
    Errors
  117. def staticPathSegment(segment: String): Path[Unit]

    A path segment whose value is the given segment

    A path segment whose value is the given segment

    Definition Classes
    UrlsUrls
  118. def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  119. def stringSegment: Segment[String]

    Path segment codec for type String

    Path segment codec for type String

    • Server interpreters should return an URL-decoded string value,
    • Client interpreters should take an URL-decoded string value.
    Definition Classes
    UrlsUrls
  120. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  121. lazy val textRequest: Map[String, MediaType]

    Request with a String body.

    Request with a String body.

    • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
    • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
    • Client interpreters supply content-type text/plain with an explicit character encoding
    Definition Classes
    RequestsRequests
  122. def textResponse: ResponseEntity[String]

    Text response entity

    Text response entity

    • Server interpreters produce an HTTP response with a text/plain content type.
    Definition Classes
    ResponsesResponses
  123. def toString(): String
    Definition Classes
    AnyRef → Any
  124. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  125. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    UrlsUrls
  126. def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

    Definition Classes
    UrlsUrls
  127. def uuidSegment: Segment[UUID]

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    UrlsUrls
  128. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  131. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]

    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).

    Definition Classes
    Responses
  132. case object Delete extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  133. case object Get extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  134. case object Options extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  135. case object Patch extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  136. case object Post extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  137. case object Put extends Method with Product with Serializable

    Definition Classes
    MethodsMethods

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (BasicAuthentication, B)
    Implicit
    This member is added by an implicit conversion from BasicAuthentication toArrowAssoc[BasicAuthentication] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Headers

Inherited from Methods

Inherited from Urls

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBasicAuthentication to any2stringadd[BasicAuthentication]

Inherited by implicit conversion StringFormat fromBasicAuthentication to StringFormat[BasicAuthentication]

Inherited by implicit conversion Ensuring fromBasicAuthentication to Ensuring[BasicAuthentication]

Inherited by implicit conversion ArrowAssoc fromBasicAuthentication to ArrowAssoc[BasicAuthentication]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped