Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/add jsonschema docs #19

Merged
merged 6 commits into from
Jan 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions docs/README.md

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions docs/add-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Untitled undefined type in + Schema

```txt
http://jsonlogic.com/schemas/operators/arithmetic/add.json#/properties
```




| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add.json\*](operators/arithmetic/add.json "open original schema") |

## properties Type

unknown
92 changes: 92 additions & 0 deletions docs/add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# + Schema

```txt
http://jsonlogic.com/schemas/operators/arithmetic/add.json
```

Addition. Because addition is associative, it happily take as many args as you want. Passing just one argument to + casts it to a number.


| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ---------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [add.json](operators/arithmetic/add.json "open original schema") |

## + Type

`object` ([+](add.md))

# + Properties

| Property | Type | Required | Nullable | Defined by |
| :------- | ------ | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- |
| [+](#+) | Merged | Required | cannot be null | [+](cat-properties-1-or-more-args.md "http://jsonlogic.com/schemas/common/one-or-more-args.json#/properties/+") |

## +

With 1 or more arguments.


`+`

- is required
- Type: merged type ([1 or more args](cat-properties-1-or-more-args.md))
- cannot be null
- defined in: [+](cat-properties-1-or-more-args.md "http://jsonlogic.com/schemas/common/one-or-more-args.json#/properties/+")

### + Type

merged type ([1 or more args](cat-properties-1-or-more-args.md))

one (and only one) of

- [Single Array](one-or-more-args-oneof-single-array.md "check type definition")
- one (and only one) of

- one (and only one) of

- [var](all-operators-oneof-var.md "check type definition")
- [missing](all-operators-oneof-missing.md "check type definition")
- [missing_some](all-operators-oneof-missing_some.md "check type definition")
- [+](all-operators-oneof--4.md "check type definition")
- [/](all-operators-oneof--5.md "check type definition")
- [%](all-operators-oneof--2.md "check type definition")
- [\*](all-operators-oneof--3.md "check type definition")
- [-](all-operators-oneof--.md "check type definition")
- [all](all-operators-oneof-all.md "check type definition")
- [filter](var-oneof-filter.md "check type definition")
- [map](var-oneof-map.md "check type definition")
- [merge](var-oneof-merge.md "check type definition")
- [none](all-operators-oneof-none.md "check type definition")
- [reduce](var-oneof-reduce.md "check type definition")
- [some](all-operators-oneof-some.md "check type definition")
- [and](all-operators-oneof-and.md "check type definition")
- [Equal](all-operators-oneof-equal.md "check type definition")
- one (and only one) of

- [Untitled object in if](if-oneof-0.md "check type definition")
- [Untitled object in if](if-oneof-1.md "check type definition")
- [!](all-operators-oneof-.md "check type definition")
- [Not-Equal](all-operators-oneof-not-equal.md "check type definition")
- [!!](all-operators-oneof--1.md "check type definition")
- [or](all-operators-oneof-or.md "check type definition")
- [Strict Equal](all-operators-oneof-strict-equal.md "check type definition")
- [Strict Not-Equal](all-operators-oneof-strict-not-equal.md "check type definition")
- [in](all-operators-oneof-in.md "check type definition")
- [log](all-operators-oneof-log.md "check type definition")
- [method](all-operators-oneof-method.md "check type definition")
- [>](all-operators-oneof--8.md "check type definition")
- [>=](all-operators-oneof--9.md "check type definition")
- [<](all-operators-oneof--6.md "check type definition")
- [<=](all-operators-oneof--7.md "check type definition")
- [max](all-operators-oneof-max.md "check type definition")
- [min](all-operators-oneof-min.md "check type definition")
- [cat](all-operators-oneof-cat.md "check type definition")
- [substr](all-operators-oneof-substr.md "check type definition")
- one (and only one) of

- [Untitled undefined type in All](all-types-wo-array-oneof-0.md "check type definition")
- one (and only one) of

- [Empty object.](no-logic-object-oneof-empty-object.md "check type definition")
- [Non-Logic single key object.](no-logic-object-oneof-non-logic-single-key-object.md "check type definition")
- [Non-Logic multiple key object.](no-logic-object-oneof-non-logic-multiple-key-object.md "check type definition")
92 changes: 92 additions & 0 deletions docs/all-operators-oneof--.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# - Schema

```txt
http://jsonlogic.com/schemas/operators/arithmetic/substract.json#/oneOf/7
```

Subtraction. Passing just one argument to - returns its arithmetic negative (additive inverse).


| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [all-operators.json\*](common/all-operators.json "open original schema") |

## 7 Type

`object` ([-](all-operators-oneof--.md))

# - Properties

| Property | Type | Required | Nullable | Defined by |
| :------- | ------ | -------- | -------------- | :---------------------------------------------------------------------------------------------------------- |
| [-](#-) | Merged | Required | cannot be null | [-](map-properties-binary-arg.md "http://jsonlogic.com/schemas/common/binary-args.json#/properties/-") |

## -

Up to two args of valid JSON Logic data source.


`-`

- is required
- Type: merged type ([Binary Arg](map-properties-binary-arg.md))
- cannot be null
- defined in: [-](map-properties-binary-arg.md "http://jsonlogic.com/schemas/common/binary-args.json#/properties/-")

### - Type

merged type ([Binary Arg](map-properties-binary-arg.md))

one (and only one) of

- [Array](binary-args-oneof-array.md "check type definition")
- one (and only one) of

- one (and only one) of

- [var](all-operators-oneof-var.md "check type definition")
- [missing](all-operators-oneof-missing.md "check type definition")
- [missing_some](all-operators-oneof-missing_some.md "check type definition")
- [+](all-operators-oneof--4.md "check type definition")
- [/](all-operators-oneof--5.md "check type definition")
- [%](all-operators-oneof--2.md "check type definition")
- [\*](all-operators-oneof--3.md "check type definition")
- [-](all-operators-oneof--.md "check type definition")
- [all](all-operators-oneof-all.md "check type definition")
- [filter](var-oneof-filter.md "check type definition")
- [map](var-oneof-map.md "check type definition")
- [merge](var-oneof-merge.md "check type definition")
- [none](all-operators-oneof-none.md "check type definition")
- [reduce](var-oneof-reduce.md "check type definition")
- [some](all-operators-oneof-some.md "check type definition")
- [and](all-operators-oneof-and.md "check type definition")
- [Equal](all-operators-oneof-equal.md "check type definition")
- one (and only one) of

- [Untitled object in if](if-oneof-0.md "check type definition")
- [Untitled object in if](if-oneof-1.md "check type definition")
- [!](all-operators-oneof-.md "check type definition")
- [Not-Equal](all-operators-oneof-not-equal.md "check type definition")
- [!!](all-operators-oneof--1.md "check type definition")
- [or](all-operators-oneof-or.md "check type definition")
- [Strict Equal](all-operators-oneof-strict-equal.md "check type definition")
- [Strict Not-Equal](all-operators-oneof-strict-not-equal.md "check type definition")
- [in](all-operators-oneof-in.md "check type definition")
- [log](all-operators-oneof-log.md "check type definition")
- [method](all-operators-oneof-method.md "check type definition")
- [>](all-operators-oneof--8.md "check type definition")
- [>=](all-operators-oneof--9.md "check type definition")
- [<](all-operators-oneof--6.md "check type definition")
- [<=](all-operators-oneof--7.md "check type definition")
- [max](all-operators-oneof-max.md "check type definition")
- [min](all-operators-oneof-min.md "check type definition")
- [cat](all-operators-oneof-cat.md "check type definition")
- [substr](all-operators-oneof-substr.md "check type definition")
- one (and only one) of

- [Untitled undefined type in All](all-types-wo-array-oneof-0.md "check type definition")
- one (and only one) of

- [Empty object.](no-logic-object-oneof-empty-object.md "check type definition")
- [Non-Logic single key object.](no-logic-object-oneof-non-logic-single-key-object.md "check type definition")
- [Non-Logic multiple key object.](no-logic-object-oneof-non-logic-multiple-key-object.md "check type definition")
92 changes: 92 additions & 0 deletions docs/all-operators-oneof--1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# !! Schema

```txt
http://jsonlogic.com/schemas/operators/logic/notnot.json#/oneOf/20
```

Double negation, or “cast to a boolean.” Takes a single argument.


| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [all-operators.json\*](common/all-operators.json "open original schema") |

## 20 Type

`object` ([!!](all-operators-oneof--1.md))

# !! Properties

| Property | Type | Required | Nullable | Defined by |
| :-------- | ------ | -------- | -------------- | :--------------------------------------------------------------------------------------------------------- |
| [!!](#!!) | Merged | Required | cannot be null | [!!](not-properties-unary-arg.md "http://jsonlogic.com/schemas/common/unary-arg.json#/properties/!!") |

## !!

Only one valid JSON Logic data source.


`!!`

- is required
- Type: merged type ([Unary Arg](not-properties-unary-arg.md))
- cannot be null
- defined in: [!!](not-properties-unary-arg.md "http://jsonlogic.com/schemas/common/unary-arg.json#/properties/!!")

### !! Type

merged type ([Unary Arg](not-properties-unary-arg.md))

one (and only one) of

- [Single Array](unary-arg-oneof-single-array.md "check type definition")
- one (and only one) of

- one (and only one) of

- [var](all-operators-oneof-var.md "check type definition")
- [missing](all-operators-oneof-missing.md "check type definition")
- [missing_some](all-operators-oneof-missing_some.md "check type definition")
- [+](all-operators-oneof--4.md "check type definition")
- [/](all-operators-oneof--5.md "check type definition")
- [%](all-operators-oneof--2.md "check type definition")
- [\*](all-operators-oneof--3.md "check type definition")
- [-](all-operators-oneof--.md "check type definition")
- [all](all-operators-oneof-all.md "check type definition")
- [filter](var-oneof-filter.md "check type definition")
- [map](var-oneof-map.md "check type definition")
- [merge](var-oneof-merge.md "check type definition")
- [none](all-operators-oneof-none.md "check type definition")
- [reduce](var-oneof-reduce.md "check type definition")
- [some](all-operators-oneof-some.md "check type definition")
- [and](all-operators-oneof-and.md "check type definition")
- [Equal](all-operators-oneof-equal.md "check type definition")
- one (and only one) of

- [Untitled object in if](if-oneof-0.md "check type definition")
- [Untitled object in if](if-oneof-1.md "check type definition")
- [!](all-operators-oneof-.md "check type definition")
- [Not-Equal](all-operators-oneof-not-equal.md "check type definition")
- [!!](all-operators-oneof--1.md "check type definition")
- [or](all-operators-oneof-or.md "check type definition")
- [Strict Equal](all-operators-oneof-strict-equal.md "check type definition")
- [Strict Not-Equal](all-operators-oneof-strict-not-equal.md "check type definition")
- [in](all-operators-oneof-in.md "check type definition")
- [log](all-operators-oneof-log.md "check type definition")
- [method](all-operators-oneof-method.md "check type definition")
- [>](all-operators-oneof--8.md "check type definition")
- [>=](all-operators-oneof--9.md "check type definition")
- [<](all-operators-oneof--6.md "check type definition")
- [<=](all-operators-oneof--7.md "check type definition")
- [max](all-operators-oneof-max.md "check type definition")
- [min](all-operators-oneof-min.md "check type definition")
- [cat](all-operators-oneof-cat.md "check type definition")
- [substr](all-operators-oneof-substr.md "check type definition")
- one (and only one) of

- [Untitled undefined type in All](all-types-wo-array-oneof-0.md "check type definition")
- one (and only one) of

- [Empty object.](no-logic-object-oneof-empty-object.md "check type definition")
- [Non-Logic single key object.](no-logic-object-oneof-non-logic-single-key-object.md "check type definition")
- [Non-Logic multiple key object.](no-logic-object-oneof-non-logic-multiple-key-object.md "check type definition")
Loading