schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | uniqueItems | If true, all items in the array need to be unique | {"type": "boolean", "default": false} |
api.json | items | This property describes what the items in an array should look like. | {} |
api.json | minimum | The minimum value of the number. | {"type": "integer", "example": 0} |
api.json | maximum | The maximum value of the number. | {"type": "integer", "example": 100} |
api.json | multipleOf | The value must be a multiple of this number.
For example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,
5, 7, 8, etc.
| {"type": "integer"} |
api.json | maxProperties | The maximum number of properties the object is allowed to have. | {"type": "integer", "minimum": 0} |
api.json | minProperties | The minimum number of properties the object is must have. | {"type": "integer", "minimum": 1} |
api.json | properties | A mapping of object keys for the object to nested JSON schemas. | {"type": "object", "additionalProperties": {}} |
api.json | required | A list of properties that are required. | {"type": "array", "minItems": 1, "items": {"type": "string"}} |
api.json | items | A property name which is required on the object. | {"type": "string"} |
api.json | additionalProperties | Describe if this object is allowed to have properties besides those defined in `properties`
It’s recommended to set this to `false`.
| {"example": false, "anyOf": [{"type": "boolean"}, {}]} |
api.json | additionalProperties | If false, the object may not have any additional properties.
If true, the object may have **any** type of additional properties. This is **not** recommended.
| {"type": "boolean"} |
api.json | additionalProperties | If this is a JSON schema, it describes any additional properties. | {} |
api.json | format | The format values should adhere to. | {"enum": ["date-time", "time", "date", "duration", "email", "idn-email", "hostname", "idn-hostname", "ipv4", "ipv6", "uuid", "uri", "uri-reference", "iri", "iri-reference", "uri-template", "json-pointer", "relative-json-pointer", "regex", "action", "binary", "event-emitter", "event-listener", "fontawesome"]} |
api.json | minLength | The minimum length of the string. | {"type": "integer", "minimum": 1} |
api.json | maxLength | The maximum length of the string.
It’s highly recommended to set this property, even if it’s a big number. For example 5000 characters
is plenty for most larger input fields. Not doing so may result in extremely large user input, which
results in a bad user experience.
| {"type": "integer", "minimum": 1, "example": 5000} |
api.json | pattern | A regular expression to describe user input.
Regular expressions are a powerful way to enforce proper user input, but the learning curve is high.
If you don’t know what this is, we recommend to omit this field for now.
| {"type": "string", "minLength": 1, "format": "regex"} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaNot | A JSON schema which may not be matched. | {"type": "object", "additionalProperties": false, "required": ["not"], "properties": {"not": {}, "examples": {"type": "array", "items": {}}, "default": {}}} |
api.json | not | The JSON schema which the value may not match. | {} |
api.json | examples | An example value which is valid according to this schema. | {"type": "array", "items": {}} |
api.json | default | The default value which is used if no value is supplied. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaNull | A JSON schema of type null only accepts a null value | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["null"]}}} |
api.json | type | Only accept a null value. | {"enum": ["null"]} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaNumber | A JSON schema for a number which has fractions. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["number"]}, "enum": {"type": "array", "items": {"type": "number"}}, "const": {"type": "number"}, "examples": {"type": "array", "items": {"type": "number"}}, "default": {"type": "number"}, "minimum": {"type": "number... |
api.json | type | The type of the JSON schema. A number represents a number which has fractions. For fractionless numbers, use `integer` instead. | {"enum": ["number"]} |
api.json | enum | If an enum is specified, the type can be safely removed. | {"type": "array", "items": {"type": "number"}} |
api.json | const | If const is specified, the type can be safely removed. | {"type": "number"} |
api.json | items | An example number which is valid according to this schema. | {"type": "number"} |
api.json | default | The default value which is used if no value is supplied. | {"type": "number"} |
api.json | minimum | The minimum value of the number. | {"type": "number", "example": 0} |
api.json | maximum | The maximum value of the number. | {"type": "number", "example": 100} |
api.json | exclusiveMinimum | The value must be bigger than this number. The given value itself is not allowed. | {"type": "number"} |
api.json | exclusiveMaximum | The value must be smaller than this number. The given value itself is not allowed. | {"type": "number"} |
api.json | multipleOf | The value must be a multiple of this number.
For example, if this is set to 0.5, then the values 0, 0.5, 1, 1.5, 2, 2.5, etc. will be allowed,
but not 0.3, 1.7, etc.
| {"type": "number"} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaObject | A JSON schema for an object. | {"type": "object", "additionalProperties": false, "required": ["type", "additionalProperties"], "properties": {"type": {"enum": ["object"]}, "examples": {"type": "array", "items": {"type": "object", "additionalProperties": true}}, "default": {"type": "object", "additionalProperties": true}, "maxProperties": {"type": "i... |
api.json | type | The type of the JSON schema. | {"enum": ["object"]} |
api.json | items | An example object which is valid according to this schema. | {"type": "object", "additionalProperties": true} |
api.json | default | The default value which is used if no value is supplied. | {"type": "object", "additionalProperties": true} |
api.json | maxProperties | The maximum number of properties the object is allowed to have. | {"type": "integer", "minimum": 0} |
api.json | minProperties | The minimum number of properties the object is must have. | {"type": "integer", "minimum": 1} |
api.json | required | A list of properties that are required. | {"type": "array", "minItems": 1, "items": {"type": "string"}} |
api.json | items | A property name which is required on the object. | {"type": "string"} |
api.json | properties | A mapping of object keys for the object to nested JSON schemas. | {"type": "object", "additionalProperties": {}} |
api.json | additionalProperties | Describe if this object is allowed to have properties besides those defined in `properties`
It’s recommended to set this to `false`.
| {"example": false, "anyOf": [{"type": "boolean"}, {}]} |
api.json | additionalProperties | If false, the object may not have any additional properties.
If true, the object may have **any** type of additional properties. This is **not** recommended.
| {"type": "boolean"} |
api.json | additionalProperties | If this is a JSON schema, it describes any additional properties. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaOneOf | A JSON schema which determines the value must match exactly one of the given schemas. | {"type": "object", "additionalProperties": false, "required": ["oneOf"], "properties": {"oneOf": {"type": "array", "items": {}}, "example": {}, "default": {}}} |
api.json | properties | The JSON schema must match exactly one of the given schemas. | {"type": "array", "items": {}} |
api.json | example | An example value which is valid according to this schema. | {} |
api.json | default | The default value which is used if no value is supplied. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaRemapper | A JSON schema which allows a format of remapper without a type. | {"type": "object", "additionalProperties": false, "required": ["format"], "properties": {"format": {"enum": ["remapper"]}, "default": {}}} |
api.json | format | Allow a remapper definition. This is supported for blocks only. | {"enum": ["remapper"]} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaRoot | A top level JSON schema. | {"type": "object", "additionalProperties": false, "properties": {"definitions": {"additionalProperties": {}}, "$schema": {"enum": ["http://json-schema.org/draft-04/schema#", "http://json-schema.org/draft-07/schema#"], "default": "http://json-schema.org/draft-07/schema#"}, "type": {"enum": ["object"]}, "examples": {"typ... |
api.json | definitions | This property may be used to store JSON schemas that may be referenced from other places. | {"additionalProperties": {}} |
api.json | $schema | The JSON schema meta schema. You probably don’t need to specify this explicitly. | {"enum": ["http://json-schema.org/draft-04/schema#", "http://json-schema.org/draft-07/schema#"], "default": "http://json-schema.org/draft-07/schema#"} |
api.json | type | The type of the JSON schema. | {"enum": ["object"]} |
api.json | items | An example object which is valid according to this schema. | {"type": "object", "additionalProperties": true} |
api.json | default | The default value which is used if no value is supplied. | {"type": "object", "additionalProperties": true} |
api.json | maxProperties | The maximum number of properties the object is allowed to have. | {"type": "integer", "minimum": 0} |
api.json | minProperties | The minimum number of properties the object is must have. | {"type": "integer", "minimum": 1} |
api.json | required | A list of properties that are required. | {"type": "array", "minItems": 1, "items": {"type": "string"}} |
api.json | items | A property name which is required on the object. | {"type": "string"} |
api.json | properties | A mapping of object keys for the object to nested JSON schemas. | {"type": "object", "additionalProperties": {}} |
api.json | additionalProperties | Describe if this object is allowed to have properties besides those defined in `properties`
It’s recommended to set this to `false`.
| {"example": false, "anyOf": [{"type": "boolean"}, {}]} |
api.json | additionalProperties | If false, the object may not have any additional properties.
If true, the object may have **any** type of additional properties. This is **not** recommended.
| {"type": "boolean"} |
api.json | additionalProperties | If this is a JSON schema, it describes any additional properties. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaString | A JSON schema for a string. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["string"]}, "examples": {"type": "array", "items": {"type": "string"}}, "default": {"type": "string"}, "enum": {"type": "array", "items": {"type": "string"}}, "const": {"type": "string"}, "format": {"enum": ["date-t... |
api.json | type | The type of the JSON schema. A string is the technical term for a piece of text. | {"enum": ["string"]} |
api.json | items | An example string which is valid according to this schema. | {"type": "string"} |
api.json | default | The default value which is used if no value is supplied. | {"type": "string"} |
api.json | enum | If an enum is specified, the type can be safely removed. | {"type": "array", "items": {"type": "string"}} |
api.json | const | If const is specified, the type can be safely removed. | {"type": "string"} |
api.json | format | The format values should adhere to. | {"enum": ["date-time", "time", "date", "duration", "email", "idn-email", "hostname", "idn-hostname", "ipv4", "ipv6", "uuid", "uri", "uri-reference", "iri", "iri-reference", "uri-template", "json-pointer", "relative-json-pointer", "regex", "action", "binary", "event-emitter", "event-listener", "fontawesome"]} |
api.json | minLength | The minimum length of the string. | {"type": "integer", "minimum": 1} |
api.json | maxLength | The maximum length of the string.
It’s highly recommended to set this property, even if it’s a big number. For example 5000 characters
is plenty for most larger input fields. Not doing so may result in extremely large user input, which
results in a bad user experience.
| {"type": "integer", "minimum": 1, "example": 5000} |
api.json | pattern | A regular expression to describe user input.
Regular expressions are a powerful way to enforce proper user input, but the learning curve is high.
If you don’t know what this is, we recommend to omit this field for now.
| {"type": "string", "minLength": 1, "format": "regex"} |
api.json | multiline | If true, Appsemble renders a textarea in the graphical JSON editor. | {"type": "boolean", "default": false} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | type | The link action can be used to redirect the user to other pages or absolute URLs. | {"enum": ["link"]} |
api.json | to | The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage. | {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]} |
api.json | type | Link back to the previous page in the browser history. | {"enum": ["link.back"]} |
api.json | type | Link to the next page in the browser history. | {"enum": ["link.next"]} |
api.json | type | Output the result of the action into the console.
This is mostly useful for debugging blocks during development.
| {"enum": ["log"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.