Interface INopeDescriptor

INopeDescriptor

A generic descriptor of data or a function. This descriptors will be used to describe NoPE data-points or functions. The Descriptor is based on JSON-Schemas (see here for more details).

Describing data

A valid example - describing some data - is given below (in the form of JSON-data). This example matches a JSON-Schema: *

{
 "title": "Person",
 "type": "object",
 "properties": {
   "firstName": {
     "type": "string",
     "description": "The person's first name."
   },
   "lastName": {
     "type": "string",
     "description": "The person's last name."
   },
   "age": {
     "description": "Age in years which must be equal to or greater than zero.",
     "type": "integer",
     "minimum": 0
   }
 }
}

Describing functions

A valid example - describing a function - is given below (in the form of JSON-data):

{
 "type": "function",
 "description": "A Sample Function",
 "inputs": [
   {
     "name": "parameter_01",
     "description": "The first Parameter of the Function",
     "schema": {
       "type":"string",
       "maxLength": 10
     }
   },
   {
     "name": "parameter_02",
     "description": "The second Parameter of the Function. This is optional",
     "optional": true,
     "schema": {
       "type":"boolean"
     }
   }
 ]
}

Export

INopeDescriptor

Hierarchy

  • INopeDescriptor

Properties

$id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? default? definitions? dependencies? description? enum? examples? exclusiveMaximum? exclusiveMinimum? inputs? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? outputs? pattern? patternProperties? properties? required? title? type? uniqueItems?

Properties

Optional $id

$id?: string

This is important because it tells refs where the root of the document is located

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: boolean | INopeDescriptor

Optional additionalProperties

additionalProperties?: boolean | INopeDescriptor

Optional allOf

allOf?: INopeDescriptor[]

Optional anyOf

anyOf?: INopeDescriptor[]

Optional default

default?: any

Default json for the object represented by

Optional definitions

definitions?: {
    [key: string]: INopeDescriptor;
}

Holds simple JSON Schema definitions for referencing from elsewhere.

Type declaration

Optional dependencies

dependencies?: {
    [key: string]: INopeDescriptor | string[];
}

If the key is present as a property then the string of properties must also be present. If the value is a JSON Schema then it must also be valid for the object if the key is present.

Type declaration

Optional description

description?: string

Schema description

Optional enum

enum?: any[]

Enumerates the values that this schema can be e.g.

{ "type": "string", "enum": ["red", "green", "blue"] }

Optional examples

examples?: any

Optional exclusiveMaximum

exclusiveMaximum?: boolean

If true maximum must be > value, >= otherwise

Optional exclusiveMinimum

exclusiveMinimum?: boolean

If true minimum must be < value, <= otherwise

Optional inputs

inputs?: INopeDescriptorFunctionParameter[]

Data-Field, which must be filled out, if we are describing a function. This will describe the entire data of the inputs.

Optional items

items?: INopeDescriptor | INopeDescriptor[]

Optional maxItems

maxItems?: number

max. amount of items, the array is allwoed to contain.

Optional maxLength

maxLength?: number

Max length of the string.

Optional maxProperties

maxProperties?: number

Optional maximum

maximum?: number

Optional minItems

minItems?: number

min. amount of items, the array must contain.

Optional minLength

minLength?: number

Min length of the string.

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

The value must be a multiple of the number (e.g. 10 is a multiple of 5)

Optional not

not?: INopeDescriptor

The entity being validated must not match this schema

Optional oneOf

oneOf?: INopeDescriptor[]

Optional outputs

outputs?: INopeDescriptor | INopeDescriptorFunctionParameter[]

The Return (output) of a function. This must be provided if the type is set to function type

Optional pattern

pattern?: string

This is a regex string that the value must conform to

Optional patternProperties

patternProperties?: {
    [pattern: string]: INopeDescriptor;
}

The key of this object is a regex for which properties the schema applies to

Type declaration

Optional properties

properties?: {
    [property: string]: INopeDescriptor;
}

The keys that can exist on the object with the json schema that should validate their value

Type declaration

Optional required

required?: string[]

Props that must be integrated

Optional title

title?: string

Title of the schema

Optional type

type?: INopeDescriptorSchemaTypes

The basic type of this schema, can be one of ['string' | 'number' | 'object' | 'array' | 'boolean' | 'null'] or an array of the acceptable types

Optional uniqueItems

uniqueItems?: boolean

Flag, to define, that every item in the array must be unique.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc