The cl-json-schema Reference Manual

This is the cl-json-schema Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:08:44 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-json-schema

Describe cl-json-schema here

Author

Your Name <>

License

Specify license here

Version

0.0.1

Dependencies
  • alexandria (system).
  • yason (system).
  • trivial-do (system).
  • cl-ppcre (system).
Source

cl-json-schema.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 cl-json-schema/cl-json-schema.asd

Source

cl-json-schema.asd.

Parent Component

cl-json-schema (system).

ASDF Systems

cl-json-schema.


3.1.2 cl-json-schema/package.lisp

Source

cl-json-schema.asd.

Parent Component

cl-json-schema (system).

Packages

cl-json-schema.


3.1.3 cl-json-schema/errors.lisp

Dependency

package.lisp (file).

Source

cl-json-schema.asd.

Parent Component

cl-json-schema (system).

Public Interface
Internals

3.1.4 cl-json-schema/cl-json-schema.lisp

Dependency

errors.lisp (file).

Source

cl-json-schema.asd.

Parent Component

cl-json-schema (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-json-schema

Source

package.lisp.

Nickname

json-schema

Use List

common-lisp.

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: json-schema-error (message &rest rest)
Package

cl-json-schema.

Source

errors.lisp.

Function: validate (thing schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-boolean (boolean schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-integer (integer schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-number (number schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-object (object schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-string (string schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.


5.1.2 Generic functions

Generic Reader: json-schema-error-datum (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-datum ((condition json-schema-error))
Source

errors.lisp.

Target Slot

datum.

Generic Reader: json-schema-error-exclusive-maximum (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-exclusive-maximum ((condition json-schema-range-error))
Source

errors.lisp.

Target Slot

exclusive-maximum.

Generic Reader: json-schema-error-exclusive-minimum (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-exclusive-minimum ((condition json-schema-range-error))
Source

errors.lisp.

Target Slot

exclusive-minimum.

Generic Reader: json-schema-error-expected-type (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-expected-type ((condition json-schema-invalid-type-error))
Source

errors.lisp.

Target Slot

expected-type.

Generic Reader: json-schema-error-invalid-type (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-invalid-type ((condition json-schema-invalid-type-error))
Source

errors.lisp.

Target Slot

invalid-type.

Generic Reader: json-schema-error-max-length (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-max-length ((condition json-schema-length-error))
Source

errors.lisp.

Target Slot

max-length.

Generic Reader: json-schema-error-maximum (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-maximum ((condition json-schema-range-error))
Source

errors.lisp.

Target Slot

maximum.

Generic Reader: json-schema-error-maximum-properties (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-maximum-properties ((condition json-schema-properties-size-error))
Source

errors.lisp.

Target Slot

maximum-properties.

Generic Reader: json-schema-error-min-length (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-min-length ((condition json-schema-length-error))
Source

errors.lisp.

Target Slot

min-length.

Generic Reader: json-schema-error-minimum (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-minimum ((condition json-schema-range-error))
Source

errors.lisp.

Target Slot

minimum.

Generic Reader: json-schema-error-minimum-properties (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-minimum-properties ((condition json-schema-properties-size-error))
Source

errors.lisp.

Target Slot

minimum-properties.

Generic Reader: json-schema-error-multiple (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-multiple ((condition json-schema-multipleof-error))
Source

errors.lisp.

Target Slot

multiple.

Generic Reader: json-schema-error-pattern (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-pattern ((condition json-schema-pattern-error))
Source

errors.lisp.

Target Slot

pattern.

Generic Reader: json-schema-error-property-name (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-property-name ((condition json-schema-additional-property-error))
Source

errors.lisp.

Target Slot

property-name.

Reader Method: json-schema-error-property-name ((condition json-schema-required-property-error))
Source

errors.lisp.

Target Slot

property-name.

Generic Reader: json-schema-error-provided-properties (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-provided-properties ((condition json-schema-properties-size-error))
Source

errors.lisp.

Target Slot

provided-properties.

Generic Reader: json-schema-error-schema (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-schema ((condition json-schema-error))
Source

errors.lisp.

Target Slot

schema.

Generic Reader: json-schema-error-schema-type (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-schema-type ((condition json-schema-invalid-schema-type-error))
Source

errors.lisp.

Target Slot

schema-type.


5.1.3 Conditions

Condition: json-schema-additional-property-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods

json-schema-error-property-name.

Direct slots
Slot: property-name
Initargs

:property-name

Readers

json-schema-error-property-name.

Writers

This slot is read-only.

Condition: json-schema-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods
Direct slots
Slot: schema
Initform

(quote nil)

Initargs

:schema

Readers

json-schema-error-schema.

Writers

This slot is read-only.

Slot: datum
Initform

(quote nil)

Initargs

:datum

Readers

json-schema-error-datum.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

json-schema-error-message.

Writers

This slot is read-only.

Condition: json-schema-invalid-schema-type-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods

json-schema-error-schema-type.

Direct slots
Slot: schema-type
Initargs

:schema-type

Readers

json-schema-error-schema-type.

Writers

This slot is read-only.

Condition: json-schema-invalid-type-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods
Direct slots
Slot: expected-type
Initargs

:expected-type

Readers

json-schema-error-expected-type.

Writers

This slot is read-only.

Slot: invalid-type
Initargs

:invalid-type

Readers

json-schema-error-invalid-type.

Writers

This slot is read-only.

Condition: json-schema-length-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods
Direct slots
Slot: min-length
Initargs

:min-length

Readers

json-schema-error-min-length.

Writers

This slot is read-only.

Slot: max-length
Initargs

:max-length

Readers

json-schema-error-max-length.

Writers

This slot is read-only.

Condition: json-schema-multipleof-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods

json-schema-error-multiple.

Direct slots
Slot: multiple
Initargs

:multiple

Readers

json-schema-error-multiple.

Writers

This slot is read-only.

Condition: json-schema-pattern-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods

json-schema-error-pattern.

Direct slots
Slot: pattern
Initargs

:pattern

Readers

json-schema-error-pattern.

Writers

This slot is read-only.

Condition: json-schema-properties-size-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods
Direct slots
Slot: minimum-properties
Initargs

:minimum-properties

Readers

json-schema-error-minimum-properties.

Writers

This slot is read-only.

Slot: maximum-properties
Initargs

:maximum-properties

Readers

json-schema-error-maximum-properties.

Writers

This slot is read-only.

Slot: provided-properties
Initargs

:provided-properties

Readers

json-schema-error-provided-properties.

Writers

This slot is read-only.

Condition: json-schema-range-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct methods
Direct slots
Slot: minimum
Initargs

:minimum

Readers

json-schema-error-minimum.

Writers

This slot is read-only.

Slot: exclusive-minimum
Initargs

:exclusive-minimum

Readers

json-schema-error-exclusive-minimum.

Writers

This slot is read-only.

Slot: maximum
Initargs

:maximum

Readers

json-schema-error-maximum.

Writers

This slot is read-only.

Slot: exclusive-maximum
Initargs

:exclusive-maximum

Readers

json-schema-error-exclusive-maximum.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *schema-reserved-keywords*
Package

cl-json-schema.

Source

cl-json-schema.lisp.


5.2.2 Ordinary functions

Function: lisp->json (thing)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: matching-key (value regex-keyed-table)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-array (array schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.

Function: validate-number-properties (number schema)
Package

cl-json-schema.

Source

cl-json-schema.lisp.


5.2.3 Generic functions

Generic Reader: json-schema-error-message (condition)
Package

cl-json-schema.

Methods
Reader Method: json-schema-error-message ((condition json-schema-error))
Source

errors.lisp.

Target Slot

message.


5.2.4 Conditions

Condition: json-schema-required-property-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-error.

Direct subclasses

json-schema-required-property-missing-error.

Direct methods

json-schema-error-property-name.

Direct slots
Slot: property-name
Initargs

:property-name

Readers

json-schema-error-property-name.

Writers

This slot is read-only.

Condition: json-schema-required-property-missing-error
Package

cl-json-schema.

Source

errors.lisp.

Direct superclasses

json-schema-required-property-error.


5.2.5 Types

Type: json-type ()
Package

cl-json-schema.

Source

cl-json-schema.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   F   G   J   L   M   V  
Index Entry  Section

F
Function, json-schema-error: Public ordinary functions
Function, lisp->json: Private ordinary functions
Function, matching-key: Private ordinary functions
Function, validate: Public ordinary functions
Function, validate-array: Private ordinary functions
Function, validate-boolean: Public ordinary functions
Function, validate-integer: Public ordinary functions
Function, validate-number: Public ordinary functions
Function, validate-number-properties: Private ordinary functions
Function, validate-object: Public ordinary functions
Function, validate-string: Public ordinary functions

G
Generic Function, json-schema-error-datum: Public generic functions
Generic Function, json-schema-error-exclusive-maximum: Public generic functions
Generic Function, json-schema-error-exclusive-minimum: Public generic functions
Generic Function, json-schema-error-expected-type: Public generic functions
Generic Function, json-schema-error-invalid-type: Public generic functions
Generic Function, json-schema-error-max-length: Public generic functions
Generic Function, json-schema-error-maximum: Public generic functions
Generic Function, json-schema-error-maximum-properties: Public generic functions
Generic Function, json-schema-error-message: Private generic functions
Generic Function, json-schema-error-min-length: Public generic functions
Generic Function, json-schema-error-minimum: Public generic functions
Generic Function, json-schema-error-minimum-properties: Public generic functions
Generic Function, json-schema-error-multiple: Public generic functions
Generic Function, json-schema-error-pattern: Public generic functions
Generic Function, json-schema-error-property-name: Public generic functions
Generic Function, json-schema-error-provided-properties: Public generic functions
Generic Function, json-schema-error-schema: Public generic functions
Generic Function, json-schema-error-schema-type: Public generic functions

J
json-schema-error: Public ordinary functions
json-schema-error-datum: Public generic functions
json-schema-error-datum: Public generic functions
json-schema-error-exclusive-maximum: Public generic functions
json-schema-error-exclusive-maximum: Public generic functions
json-schema-error-exclusive-minimum: Public generic functions
json-schema-error-exclusive-minimum: Public generic functions
json-schema-error-expected-type: Public generic functions
json-schema-error-expected-type: Public generic functions
json-schema-error-invalid-type: Public generic functions
json-schema-error-invalid-type: Public generic functions
json-schema-error-max-length: Public generic functions
json-schema-error-max-length: Public generic functions
json-schema-error-maximum: Public generic functions
json-schema-error-maximum: Public generic functions
json-schema-error-maximum-properties: Public generic functions
json-schema-error-maximum-properties: Public generic functions
json-schema-error-message: Private generic functions
json-schema-error-message: Private generic functions
json-schema-error-min-length: Public generic functions
json-schema-error-min-length: Public generic functions
json-schema-error-minimum: Public generic functions
json-schema-error-minimum: Public generic functions
json-schema-error-minimum-properties: Public generic functions
json-schema-error-minimum-properties: Public generic functions
json-schema-error-multiple: Public generic functions
json-schema-error-multiple: Public generic functions
json-schema-error-pattern: Public generic functions
json-schema-error-pattern: Public generic functions
json-schema-error-property-name: Public generic functions
json-schema-error-property-name: Public generic functions
json-schema-error-property-name: Public generic functions
json-schema-error-provided-properties: Public generic functions
json-schema-error-provided-properties: Public generic functions
json-schema-error-schema: Public generic functions
json-schema-error-schema: Public generic functions
json-schema-error-schema-type: Public generic functions
json-schema-error-schema-type: Public generic functions

L
lisp->json: Private ordinary functions

M
matching-key: Private ordinary functions
Method, json-schema-error-datum: Public generic functions
Method, json-schema-error-exclusive-maximum: Public generic functions
Method, json-schema-error-exclusive-minimum: Public generic functions
Method, json-schema-error-expected-type: Public generic functions
Method, json-schema-error-invalid-type: Public generic functions
Method, json-schema-error-max-length: Public generic functions
Method, json-schema-error-maximum: Public generic functions
Method, json-schema-error-maximum-properties: Public generic functions
Method, json-schema-error-message: Private generic functions
Method, json-schema-error-min-length: Public generic functions
Method, json-schema-error-minimum: Public generic functions
Method, json-schema-error-minimum-properties: Public generic functions
Method, json-schema-error-multiple: Public generic functions
Method, json-schema-error-pattern: Public generic functions
Method, json-schema-error-property-name: Public generic functions
Method, json-schema-error-property-name: Public generic functions
Method, json-schema-error-provided-properties: Public generic functions
Method, json-schema-error-schema: Public generic functions
Method, json-schema-error-schema-type: Public generic functions

V
validate: Public ordinary functions
validate-array: Private ordinary functions
validate-boolean: Public ordinary functions
validate-integer: Public ordinary functions
validate-number: Public ordinary functions
validate-number-properties: Private ordinary functions
validate-object: Public ordinary functions
validate-string: Public ordinary functions


A.3 Variables

Jump to:   *  
D   E   I   M   P   S  
Index Entry  Section

*
*schema-reserved-keywords*: Private special variables

D
datum: Public conditions

E
exclusive-maximum: Public conditions
exclusive-minimum: Public conditions
expected-type: Public conditions

I
invalid-type: Public conditions

M
max-length: Public conditions
maximum: Public conditions
maximum-properties: Public conditions
message: Public conditions
min-length: Public conditions
minimum: Public conditions
minimum-properties: Public conditions
multiple: Public conditions

P
pattern: Public conditions
property-name: Public conditions
property-name: Private conditions
provided-properties: Public conditions

S
schema: Public conditions
schema-type: Public conditions
Slot, datum: Public conditions
Slot, exclusive-maximum: Public conditions
Slot, exclusive-minimum: Public conditions
Slot, expected-type: Public conditions
Slot, invalid-type: Public conditions
Slot, max-length: Public conditions
Slot, maximum: Public conditions
Slot, maximum-properties: Public conditions
Slot, message: Public conditions
Slot, min-length: Public conditions
Slot, minimum: Public conditions
Slot, minimum-properties: Public conditions
Slot, multiple: Public conditions
Slot, pattern: Public conditions
Slot, property-name: Public conditions
Slot, property-name: Private conditions
Slot, provided-properties: Public conditions
Slot, schema: Public conditions
Slot, schema-type: Public conditions
Special Variable, *schema-reserved-keywords*: Private special variables


A.4 Data types

Jump to:   C   E   F   J   P   S   T  
Index Entry  Section

C
cl-json-schema: The cl-json-schema system
cl-json-schema: The cl-json-schema package
cl-json-schema.asd: The cl-json-schema/cl-json-schema․asd file
cl-json-schema.lisp: The cl-json-schema/cl-json-schema․lisp file
Condition, json-schema-additional-property-error: Public conditions
Condition, json-schema-error: Public conditions
Condition, json-schema-invalid-schema-type-error: Public conditions
Condition, json-schema-invalid-type-error: Public conditions
Condition, json-schema-length-error: Public conditions
Condition, json-schema-multipleof-error: Public conditions
Condition, json-schema-pattern-error: Public conditions
Condition, json-schema-properties-size-error: Public conditions
Condition, json-schema-range-error: Public conditions
Condition, json-schema-required-property-error: Private conditions
Condition, json-schema-required-property-missing-error: Private conditions

E
errors.lisp: The cl-json-schema/errors․lisp file

F
File, cl-json-schema.asd: The cl-json-schema/cl-json-schema․asd file
File, cl-json-schema.lisp: The cl-json-schema/cl-json-schema․lisp file
File, errors.lisp: The cl-json-schema/errors․lisp file
File, package.lisp: The cl-json-schema/package․lisp file

J
json-schema-additional-property-error: Public conditions
json-schema-error: Public conditions
json-schema-invalid-schema-type-error: Public conditions
json-schema-invalid-type-error: Public conditions
json-schema-length-error: Public conditions
json-schema-multipleof-error: Public conditions
json-schema-pattern-error: Public conditions
json-schema-properties-size-error: Public conditions
json-schema-range-error: Public conditions
json-schema-required-property-error: Private conditions
json-schema-required-property-missing-error: Private conditions
json-type: Private types

P
Package, cl-json-schema: The cl-json-schema package
package.lisp: The cl-json-schema/package․lisp file

S
System, cl-json-schema: The cl-json-schema system

T
Type, json-type: Private types