Skip to content

Commit

Permalink
Fix wrong jsdoc links
Browse files Browse the repository at this point in the history
Fixes #67
  • Loading branch information
satazor committed May 2, 2020
1 parent 55bedfe commit 0cd496f
Show file tree
Hide file tree
Showing 8 changed files with 178 additions and 178 deletions.
254 changes: 127 additions & 127 deletions docs/API.md

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions src/ArraySchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* Omitting this keyword has the same behavior as an empty schema.
*
* @param {FluentSchema|FluentSchema[]} items
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.1|reference}
* @returns {FluentSchema}
*/

Expand Down Expand Up @@ -67,7 +67,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
*
* @param {FluentSchema|boolean} items
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.2|reference}
* @returns {FluentSchema}
*/

Expand Down Expand Up @@ -95,7 +95,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* An array instance is valid against "contains" if at least one of its elements is valid against the given schema.
*
* @param {FluentSchema} value
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.2|reference}
* @returns {FluentSchema}
*/

Expand All @@ -122,7 +122,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* Omitting this keyword has the same behavior as a value of false.
*
* @param {boolean} boolean
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.5}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.5|reference}
* @returns {FluentSchema}
*/

Expand All @@ -141,7 +141,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* Omitting this keyword has the same behavior as a value of 0.
*
* @param {number} min
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.4}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.4|reference}
* @returns {FluentSchema}
*/

Expand All @@ -156,7 +156,7 @@ const ArraySchema = ({ schema = initialState, ...options } = {}) => {
* Omitting this keyword has the same behavior as a value of 0.
*
* @param {number} max
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4.3|reference}
* @returns {FluentSchema}
*/

Expand Down
32 changes: 16 additions & 16 deletions src/BaseSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const BaseSchema = (
/**
* It can be used to decorate a user interface with information about the data produced by this user interface. A title will preferably be short.
*
* {@link https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.1|reference}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.1|reference}
* @param {string} title
* @returns {BaseSchema}
*/
Expand All @@ -68,7 +68,7 @@ const BaseSchema = (
* produced by this user interface. A description provides explanation about
* the purpose of the instance described by the schema.
*
* {@link https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.1|reference}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.1|reference}
* @param {string} description
* @returns {BaseSchema}
*/
Expand All @@ -84,7 +84,7 @@ const BaseSchema = (
* The value of this keyword MUST be an array.
* There are no restrictions placed on the values within the array.
*
* {@link https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.4|reference}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.4|reference}
* @param {string} examples
* @returns {BaseSchema}
*/
Expand All @@ -111,7 +111,7 @@ const BaseSchema = (
/**
* The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.1.2|reference}
* @param {array} values
* @returns {BaseSchema}
*/
Expand All @@ -127,7 +127,7 @@ const BaseSchema = (
/**
* The value of this keyword MAY be of any type, including null.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.1.3|reference}
* @param value
* @returns {BaseSchema}
*/
Expand All @@ -139,7 +139,7 @@ const BaseSchema = (
/**
* There are no restrictions placed on the value of this keyword.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.2|reference}
* @param defaults
* @returns {BaseSchema}
*/
Expand All @@ -152,7 +152,7 @@ const BaseSchema = (
* The value of readOnly can be left empty to indicate the property is readOnly.
* It takes an optional boolean which can be used to explicitly set readOnly true/false
*
* {@link readOnly|https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.3|readOnly}
* @param {boolean|undefined} isReadOnly
* @returns {BaseSchema}
*/
Expand All @@ -166,7 +166,7 @@ const BaseSchema = (
* The value of writeOnly can be left empty to indicate the property is writeOnly.
* It takes an optional boolean which can be used to explicitly set writeOnly true/false
*
* {@link writeOnly|https://json-schema.org/latest/json-schema-validation.html#rfc.section.10.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.10.3|writeOnly}
* @param {boolean|undefined} isWriteOnly
* @returns {BaseSchema}
*/
Expand All @@ -183,7 +183,7 @@ const BaseSchema = (
* - S.prop('prop', S.number()).required()
* - S.required(['foo', 'bar'])
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.3|reference}
* @returns {FluentSchema}
*/
required: props => {
Expand Down Expand Up @@ -221,7 +221,7 @@ const BaseSchema = (
/**
* It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.7.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.7.3|reference}
* @param {array} schemas
* @returns {BaseSchema}
*/
Expand All @@ -231,7 +231,7 @@ const BaseSchema = (
/**
* It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.7.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.7.1|reference}
* @param {array} schemas
* @returns {BaseSchema}
*/
Expand All @@ -242,15 +242,15 @@ const BaseSchema = (
* It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
*
* @param {array} schemas
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.7.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.7.2|reference}
* @returns {BaseSchema}
*/

oneOf: schemas => setComposeType({ prop: 'oneOf', schemas, schema, options }),

/**
* Set a property to type string
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.1.1|reference}
* @returns {BaseSchema}
*/

Expand All @@ -268,7 +268,7 @@ const BaseSchema = (
*
* @param {BaseSchema} ifClause
* @param {BaseSchema} thenClause
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.6.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.6.1|reference}
* @returns {BaseSchema}
*/

Expand Down Expand Up @@ -314,7 +314,7 @@ const BaseSchema = (
* @param {BaseSchema} ifClause
* @param {BaseSchema} thenClause
* @param {BaseSchema} elseClause
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.6.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.6.1|reference}
* @returns {BaseSchema}
*/

Expand Down Expand Up @@ -375,7 +375,7 @@ const BaseSchema = (
* - S.string().format('date').raw({ formatMaximum: '2020-01-01' })
*
* @param {string} fragment an arbitrary JSON Schema to inject
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.3.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.3.3|reference}
* @returns {BaseSchema}
*/
raw: fragment => {
Expand Down
16 changes: 8 additions & 8 deletions src/FluentSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const S = (
/**
* Set a property to type string
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.1.1|reference}
* @returns {StringSchema}
*/

Expand All @@ -53,7 +53,7 @@ const S = (
/**
* Set a property to type number
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#numeric}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#numeric|reference}
* @returns {NumberSchema}
*/

Expand All @@ -67,7 +67,7 @@ const S = (
/**
* Set a property to type integer
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#numeric}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#numeric|reference}
* @returns {IntegerSchema}
*/

Expand All @@ -81,7 +81,7 @@ const S = (
/**
* Set a property to type boolean
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#general}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#general|reference}
* @returns {BooleanSchema}
*/

Expand All @@ -95,7 +95,7 @@ const S = (
/**
* Set a property to type array
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.4}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.4|reference}
* @returns {ArraySchema}
*/

Expand All @@ -109,7 +109,7 @@ const S = (
/**
* Set a property to type object
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5|reference}
* @returns {ObjectSchema}
*/

Expand All @@ -123,7 +123,7 @@ const S = (
/**
* Set a property to type null
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#general}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#general|reference}
* @returns {NullSchema}
*/

Expand Down Expand Up @@ -173,7 +173,7 @@ const S = (
* - S.string().format('date').raw({ formatMaximum: '2020-01-01' })
*
* @param {string} fragment an arbitrary JSON Schema to inject
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.3.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.3.3|reference}
* @returns {BaseSchema}
*/

Expand Down
2 changes: 1 addition & 1 deletion src/NullSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const NullSchema = ({ schema = initialState, ...options } = {}) => {
/**
* Set a property to type null
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.1.1|reference}
* @returns {FluentSchema}
*/
null: () => setAttribute({ schema, ...options }, ['type', 'null']),
Expand Down
10 changes: 5 additions & 5 deletions src/NumberSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const NumberSchema = (
* It represents an inclusive lower limit for a numeric instance.
*
* @param {number} min
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.2.4}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.2.4|reference}
* @returns {FluentSchema}
*/

Expand All @@ -44,7 +44,7 @@ const NumberSchema = (
* It represents an exclusive lower limit for a numeric instance.
*
* * @param {number} min
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.2.5}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.2.5|reference}
* @returns {FluentSchema}
*/

Expand All @@ -62,7 +62,7 @@ const NumberSchema = (

/**
* It represents an inclusive upper limit for a numeric instance.
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.2.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.2.2|reference}
* @returns {FluentSchema}
*/

Expand All @@ -78,7 +78,7 @@ const NumberSchema = (
* It represents an exclusive upper limit for a numeric instance.
*
* @param {number} max
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.2.3}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.2.3|reference}
* @returns {FluentSchema}
*/

Expand All @@ -98,7 +98,7 @@ const NumberSchema = (
* It's strictly greater than 0.
*
* @param {number} multiple
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.2.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.2.1|reference}
* @returns {FluentSchema}
*/

Expand Down
16 changes: 8 additions & 8 deletions src/ObjectSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* Omitting this keyword has the same behavior as an empty schema.
*
* @param {FluentSchema|boolean} value
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.6}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.6|reference}
* @returns {FluentSchema}
*/

Expand Down Expand Up @@ -74,7 +74,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword.
*
* @param {number} max
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.1}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.1|reference}
* @returns {FluentSchema}
*/

Expand All @@ -92,7 +92,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword.
*
* @param {number} min
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.2}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.2|reference}
* @returns {FluentSchema}
*/

Expand All @@ -114,7 +114,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name in this keyword's value, the child instance for that name successfully validates against each schema that corresponds to a matching regular expression.
*
* @param {object} opts
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.5}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.5|reference}
* @returns {FluentSchema}
*/

Expand Down Expand Up @@ -143,7 +143,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* If the dependency value is an array, each element in the array, if any, MUST be a string, and MUST be unique. If the dependency key is a property in the instance, each of the items in the dependency value must be a property that exists in the instance.
*
* @param {object} opts
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.7}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.7|reference}
* @returns {FluentSchema}
*/

Expand Down Expand Up @@ -172,7 +172,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* Note the property name that the schema is testing will always be a string.
*
* @param {FluentSchema} value
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.7}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.7|reference}
* @returns {FluentSchema}
*/

Expand All @@ -189,7 +189,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
/**
* The value of "properties" MUST be an object. Each value of this object MUST be a valid JSON Schema
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.4}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.6.5.4|reference}
* @param {string} name
* @param {FluentSchema} props
* @returns {FluentSchema}
Expand Down Expand Up @@ -274,7 +274,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
* The "definitions" keywords provides a standardized location for schema authors to inline re-usable JSON Schemas into a more general schema.
* There are no restrictions placed on the values within the array.
*
* {@link reference|https://json-schema.org/latest/json-schema-validation.html#rfc.section.9}
* {@link https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html#rfc.section.9|reference}
* @param {string} name
* @param {FluentSchema} props
* @returns {FluentSchema}
Expand Down
Loading

0 comments on commit 0cd496f

Please sign in to comment.