The json-responses Reference Manual

This is the json-responses Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:53:11 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 json-responses

Canned JSON responses for Hunchentoot

Author

Brad Melanson <>

License

MIT

Dependencies
  • hunchentoot (system).
  • cl-json (system).
Source

json-responses.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 json-responses/json-responses.asd

Source

json-responses.asd.

Parent Component

json-responses (system).

ASDF Systems

json-responses.


3.1.2 json-responses/package.lisp

Source

json-responses.asd.

Parent Component

json-responses (system).

Packages

ca.pinecode.json-responses.


3.1.3 json-responses/json-responses.lisp

Dependency

package.lisp (file).

Source

json-responses.asd.

Parent Component

json-responses (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 ca.pinecode.json-responses

Source

package.lisp.

Nickname

json-responses

Use List
  • common-lisp.
  • hunchentoot.
  • json.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: accepted-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: authorization-required-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: bad-gateway-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: bad-request-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: conflict-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: continue-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: created-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: expectation-failed-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: forbidden-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: gateway-timeout-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: gone-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: http-version-not-supported-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: internal-server-error-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: json-response (&key status headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: length-required-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: method-not-allowed-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: moved-permanently-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: moved-temporarily-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: multiple-choices-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: no-content-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: non-authoritative-information-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: not-acceptable-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: not-found-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: not-implemented-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: not-modified-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: ok-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: partial-content-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: precondition-failed-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: proxy-authentication-required-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: request-entity-too-large-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: request-timeout-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: request-uri-too-long-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: requested-range-not-satisfiable-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: reset-content-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: see-other-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: service-unavailable-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: switching-protocols-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: temporary-redirect-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: unsupported-media-type-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.

Function: use-proxy-response (&key headers error data)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.


5.2 Internals


5.2.1 Macros

Macro: define-json-response (name status &optional error)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.


5.2.2 Ordinary functions

Function: set-headers-from-alist (headers)
Package

ca.pinecode.json-responses.

Source

json-responses.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   U  
Index Entry  Section

A
accepted-response: Public ordinary functions
authorization-required-response: Public ordinary functions

B
bad-gateway-response: Public ordinary functions
bad-request-response: Public ordinary functions

C
conflict-response: Public ordinary functions
continue-response: Public ordinary functions
created-response: Public ordinary functions

D
define-json-response: Private macros

E
expectation-failed-response: Public ordinary functions

F
forbidden-response: Public ordinary functions
Function, accepted-response: Public ordinary functions
Function, authorization-required-response: Public ordinary functions
Function, bad-gateway-response: Public ordinary functions
Function, bad-request-response: Public ordinary functions
Function, conflict-response: Public ordinary functions
Function, continue-response: Public ordinary functions
Function, created-response: Public ordinary functions
Function, expectation-failed-response: Public ordinary functions
Function, forbidden-response: Public ordinary functions
Function, gateway-timeout-response: Public ordinary functions
Function, gone-response: Public ordinary functions
Function, http-version-not-supported-response: Public ordinary functions
Function, internal-server-error-response: Public ordinary functions
Function, json-response: Public ordinary functions
Function, length-required-response: Public ordinary functions
Function, method-not-allowed-response: Public ordinary functions
Function, moved-permanently-response: Public ordinary functions
Function, moved-temporarily-response: Public ordinary functions
Function, multiple-choices-response: Public ordinary functions
Function, no-content-response: Public ordinary functions
Function, non-authoritative-information-response: Public ordinary functions
Function, not-acceptable-response: Public ordinary functions
Function, not-found-response: Public ordinary functions
Function, not-implemented-response: Public ordinary functions
Function, not-modified-response: Public ordinary functions
Function, ok-response: Public ordinary functions
Function, partial-content-response: Public ordinary functions
Function, precondition-failed-response: Public ordinary functions
Function, proxy-authentication-required-response: Public ordinary functions
Function, request-entity-too-large-response: Public ordinary functions
Function, request-timeout-response: Public ordinary functions
Function, request-uri-too-long-response: Public ordinary functions
Function, requested-range-not-satisfiable-response: Public ordinary functions
Function, reset-content-response: Public ordinary functions
Function, see-other-response: Public ordinary functions
Function, service-unavailable-response: Public ordinary functions
Function, set-headers-from-alist: Private ordinary functions
Function, switching-protocols-response: Public ordinary functions
Function, temporary-redirect-response: Public ordinary functions
Function, unsupported-media-type-response: Public ordinary functions
Function, use-proxy-response: Public ordinary functions

G
gateway-timeout-response: Public ordinary functions
gone-response: Public ordinary functions

H
http-version-not-supported-response: Public ordinary functions

I
internal-server-error-response: Public ordinary functions

J
json-response: Public ordinary functions

L
length-required-response: Public ordinary functions

M
Macro, define-json-response: Private macros
method-not-allowed-response: Public ordinary functions
moved-permanently-response: Public ordinary functions
moved-temporarily-response: Public ordinary functions
multiple-choices-response: Public ordinary functions

N
no-content-response: Public ordinary functions
non-authoritative-information-response: Public ordinary functions
not-acceptable-response: Public ordinary functions
not-found-response: Public ordinary functions
not-implemented-response: Public ordinary functions
not-modified-response: Public ordinary functions

O
ok-response: Public ordinary functions

P
partial-content-response: Public ordinary functions
precondition-failed-response: Public ordinary functions
proxy-authentication-required-response: Public ordinary functions

R
request-entity-too-large-response: Public ordinary functions
request-timeout-response: Public ordinary functions
request-uri-too-long-response: Public ordinary functions
requested-range-not-satisfiable-response: Public ordinary functions
reset-content-response: Public ordinary functions

S
see-other-response: Public ordinary functions
service-unavailable-response: Public ordinary functions
set-headers-from-alist: Private ordinary functions
switching-protocols-response: Public ordinary functions

T
temporary-redirect-response: Public ordinary functions

U
unsupported-media-type-response: Public ordinary functions
use-proxy-response: Public ordinary functions


A.3 Variables