Yoga.HTTP.API.Route.StatusCode

class StatusCodeMap :: Symbol -> Constraintclass StatusCodeMap (sym :: Symbol)  where

Map variant constructor names (Symbols) to HTTP status codes

Members

• statusCodeFor :: Proxy sym -> StatusCode

Instances

• (StatusCodeMapImpl (Proxy sym)) => StatusCodeMap sym

class StatusCodeMapImpl (proxy :: Type)  where

Internal class that matches on Proxy types to avoid overlapping instances

Members

• statusCodeForImpl :: proxy -> StatusCode

Instances

• StatusCodeMapImpl (Proxy "continue")
• StatusCodeMapImpl (Proxy "switchingProtocols")
• StatusCodeMapImpl (Proxy "processing")
• StatusCodeMapImpl (Proxy "earlyHints")
• StatusCodeMapImpl (Proxy "ok")
• StatusCodeMapImpl (Proxy "created")
• StatusCodeMapImpl (Proxy "accepted")
• StatusCodeMapImpl (Proxy "nonAuthoritativeInformation")
• StatusCodeMapImpl (Proxy "noContent")
• StatusCodeMapImpl (Proxy "resetContent")
• StatusCodeMapImpl (Proxy "partialContent")
• StatusCodeMapImpl (Proxy "multiStatus")
• StatusCodeMapImpl (Proxy "alreadyReported")
• StatusCodeMapImpl (Proxy "imUsed")
• StatusCodeMapImpl (Proxy "multipleChoices")
• StatusCodeMapImpl (Proxy "movedPermanently")
• StatusCodeMapImpl (Proxy "found")
• StatusCodeMapImpl (Proxy "seeOther")
• StatusCodeMapImpl (Proxy "notModified")
• StatusCodeMapImpl (Proxy "useProxy")
• StatusCodeMapImpl (Proxy "temporaryRedirect")
• StatusCodeMapImpl (Proxy "permanentRedirect")
• StatusCodeMapImpl (Proxy "badRequest")
• StatusCodeMapImpl (Proxy "unauthorized")
• StatusCodeMapImpl (Proxy "paymentRequired")
• StatusCodeMapImpl (Proxy "forbidden")
• StatusCodeMapImpl (Proxy "notFound")
• StatusCodeMapImpl (Proxy "methodNotAllowed")
• StatusCodeMapImpl (Proxy "notAcceptable")
• StatusCodeMapImpl (Proxy "proxyAuthenticationRequired")
• StatusCodeMapImpl (Proxy "requestTimeout")
• StatusCodeMapImpl (Proxy "conflict")
• StatusCodeMapImpl (Proxy "gone")
• StatusCodeMapImpl (Proxy "lengthRequired")
• StatusCodeMapImpl (Proxy "preconditionFailed")
• StatusCodeMapImpl (Proxy "payloadTooLarge")
• StatusCodeMapImpl (Proxy "uriTooLong")
• StatusCodeMapImpl (Proxy "unsupportedMediaType")
• StatusCodeMapImpl (Proxy "rangeNotSatisfiable")
• StatusCodeMapImpl (Proxy "expectationFailed")
• StatusCodeMapImpl (Proxy "imATeapot")
• StatusCodeMapImpl (Proxy "misdirectedRequest")
• StatusCodeMapImpl (Proxy "unprocessableEntity")
• StatusCodeMapImpl (Proxy "locked")
• StatusCodeMapImpl (Proxy "failedDependency")
• StatusCodeMapImpl (Proxy "tooEarly")
• StatusCodeMapImpl (Proxy "upgradeRequired")
• StatusCodeMapImpl (Proxy "preconditionRequired")
• StatusCodeMapImpl (Proxy "tooManyRequests")
• StatusCodeMapImpl (Proxy "requestHeaderFieldsTooLarge")
• StatusCodeMapImpl (Proxy "unavailableForLegalReasons")
• StatusCodeMapImpl (Proxy "internalServerError")
• StatusCodeMapImpl (Proxy "notImplemented")
• StatusCodeMapImpl (Proxy "badGateway")
• StatusCodeMapImpl (Proxy "serviceUnavailable")
• StatusCodeMapImpl (Proxy "gatewayTimeout")
• StatusCodeMapImpl (Proxy "httpVersionNotSupported")
• StatusCodeMapImpl (Proxy "variantAlsoNegotiates")
• StatusCodeMapImpl (Proxy "insufficientStorage")
• StatusCodeMapImpl (Proxy "loopDetected")
• StatusCodeMapImpl (Proxy "notExtended")
• StatusCodeMapImpl (Proxy "networkAuthenticationRequired")
• (Fail (Above (Beside (Text "Unknown status code: ") (Quote sym)) (Above (Text "") (Above (Text "Valid codes:") (Above (Text " • 2xx Success: ok, created, accepted, noContent, etc.") (Above (Text " • 3xx Redirect: movedPermanently, found, seeOther, notModified, etc.") (Above (Text " • 4xx Client: badRequest, unauthorized, forbidden, notFound, conflict, unprocessableEntity, etc.") (Text " • 5xx Server: internalServerError, badGateway, serviceUnavailable, etc.")))))))) => StatusCodeMapImpl (Proxy sym)

statusCodeToString :: StatusCode -> String

Convert StatusCode to String for OpenAPI generation

newtype StatusCode

Constructors

• StatusCode Int

Instances

• Newtype StatusCode _
• Show StatusCode
• Eq StatusCode
• Ord StatusCode

class StatusCodeToLabel :: Int -> Symbol -> Constraintclass StatusCodeToLabel (code :: Int) (label :: Symbol) | code -> label

Map numeric status codes to their label names

Instances

• StatusCodeToLabel 100 "continue"
• StatusCodeToLabel 101 "switchingProtocols"
• StatusCodeToLabel 102 "processing"
• StatusCodeToLabel 103 "earlyHints"
• StatusCodeToLabel 200 "ok"
• StatusCodeToLabel 201 "created"
• StatusCodeToLabel 202 "accepted"
• StatusCodeToLabel 203 "nonAuthoritativeInformation"
• StatusCodeToLabel 204 "noContent"
• StatusCodeToLabel 205 "resetContent"
• StatusCodeToLabel 206 "partialContent"
• StatusCodeToLabel 207 "multiStatus"
• StatusCodeToLabel 208 "alreadyReported"
• StatusCodeToLabel 226 "imUsed"
• StatusCodeToLabel 300 "multipleChoices"
• StatusCodeToLabel 301 "movedPermanently"
• StatusCodeToLabel 302 "found"
• StatusCodeToLabel 303 "seeOther"
• StatusCodeToLabel 304 "notModified"
• StatusCodeToLabel 305 "useProxy"
• StatusCodeToLabel 307 "temporaryRedirect"
• StatusCodeToLabel 308 "permanentRedirect"
• StatusCodeToLabel 400 "badRequest"
• StatusCodeToLabel 401 "unauthorized"
• StatusCodeToLabel 402 "paymentRequired"
• StatusCodeToLabel 403 "forbidden"
• StatusCodeToLabel 404 "notFound"
• StatusCodeToLabel 405 "methodNotAllowed"
• StatusCodeToLabel 406 "notAcceptable"
• StatusCodeToLabel 407 "proxyAuthenticationRequired"
• StatusCodeToLabel 408 "requestTimeout"
• StatusCodeToLabel 409 "conflict"
• StatusCodeToLabel 410 "gone"
• StatusCodeToLabel 411 "lengthRequired"
• StatusCodeToLabel 412 "preconditionFailed"
• StatusCodeToLabel 413 "payloadTooLarge"
• StatusCodeToLabel 414 "uriTooLong"
• StatusCodeToLabel 415 "unsupportedMediaType"
• StatusCodeToLabel 416 "rangeNotSatisfiable"
• StatusCodeToLabel 417 "expectationFailed"
• StatusCodeToLabel 418 "imATeapot"
• StatusCodeToLabel 421 "misdirectedRequest"
• StatusCodeToLabel 422 "unprocessableEntity"
• StatusCodeToLabel 423 "locked"
• StatusCodeToLabel 424 "failedDependency"
• StatusCodeToLabel 425 "tooEarly"
• StatusCodeToLabel 426 "upgradeRequired"
• StatusCodeToLabel 428 "preconditionRequired"
• StatusCodeToLabel 429 "tooManyRequests"
• StatusCodeToLabel 431 "requestHeaderFieldsTooLarge"
• StatusCodeToLabel 451 "unavailableForLegalReasons"
• StatusCodeToLabel 500 "internalServerError"
• StatusCodeToLabel 501 "notImplemented"
• StatusCodeToLabel 502 "badGateway"
• StatusCodeToLabel 503 "serviceUnavailable"
• StatusCodeToLabel 504 "gatewayTimeout"
• StatusCodeToLabel 505 "httpVersionNotSupported"
• StatusCodeToLabel 506 "variantAlsoNegotiates"
• StatusCodeToLabel 507 "insufficientStorage"
• StatusCodeToLabel 508 "loopDetected"
• StatusCodeToLabel 510 "notExtended"
• StatusCodeToLabel 511 "networkAuthenticationRequired"