NAV Navigation

Schema 1.0.0

Channels

dummy

Messages

Operation Message Description
subscribe Numeric
subscribe String
subscribe Array
subscribe Object
subscribe Items
subscribe Properties
subscribe Combinations
subscribe Conditionals

As Subscriber

dummy

Messages

Numeric

Payload

Name Type Format Allowed Default Description
range integer int32 Minimum: 0
Maximum: 10
exclusive integer int32 Exclusive minimum: 50
Exclusive maximum: 100
multiple number double Multiple of: 7

String

Payload

Name Type Format Allowed Default Description
length string Minimum length: 1
Maximum length: 15
format string date-time
pattern string Pattern: ^[\w\d\-\_]+$

Array

Payload

Name Type Format Allowed Default Description
- array Minimum items: 1
Maximum items: 5
Unique items: true

Object

Payload

Name Type Format Allowed Default Description
protocol string HTTP
HTTPS
HTTPS Protocol.
Name of the protocol to be used.
deprecated
port integer int32 Port number.
required
url string URL.
Examples:
- dev.example.com
- pro.example.com
required
user object User.
user.name string Name.
user.surname string Surname.
user.token string Write only: true
region string EU Region.
Read only: true

Items

Payload

Name Type Format Allowed Default Description
simple array Array of strings.
simple[] string
tuple array Array of tuples.
tuple[0] string
tuple[1] integer
tuple[2] string
extra array Array of strings with additional numeric items.
extra[] string
extra[...] integer
contains array Array with one or more elements matching some schema.
contains[?] string date

Properties

Payload

Name Type Format Allowed Default Description
sized object Minimum properties: 1
Maximum properties: 5
additional object Object with additional properties.
additional.name string
additional.surname string
additional.age integer
blocked object Object with fixed properties.
Additional properties: false
blocked.name string
blocked.surname string
named object Object with property names matching some pattern.
Property names pattern: ^[\w\d\-\_]+$
properties object Object with properties matching some patterns.
properties.^S+$ string
properties.^I+$ integer

Combinations

Payload

Name Type Format Allowed Default Description
allOf integer

All of (2)
Matches all the given schemas.
All Of [1] integer int32
All Of [2] integer int64
oneOf One of (2) Matches exactly one schema.
One Of [1] string
One Of [2] integer
anyOf object
string

Any of (2)
Matches one or more schemas.
Any Of [1] object
Any Of [1].name string
Any Of [1].surname string
Any Of [2] string
not Not Doesn't match the given schema.
Not string

Conditionals

Payload

Name Type Format Allowed Default Description
address object

If
Then
Else
Address object with a conditional postal code property.
address.street string
address.country string
If object
If.country string USA
Then object
Then.postalCode string Pattern: ^[0-9]{5}(-[0-9]{4})?$
Else object
Else.postalCode string Pattern: ^[A-Z][0-9][A-Z] [0-9][A-Z][0-9]$