diff --git a/contrib/html/openapi.yaml b/contrib/html/openapi.yaml
index cd4eba86..a4ab246f 100644
--- a/contrib/html/openapi.yaml
+++ b/contrib/html/openapi.yaml
@@ -205,12 +205,12 @@ components:
schemas:
Global:
required:
- - lastup
+ - version
+ - signal
+ - reconnects
- masters
- messages
- - reconnects
- - signal
- - version
+ - lastup
type: object
properties:
version:
@@ -223,6 +223,12 @@ components:
description: the result of update check ("OK" or string describing available
updates).
example: revision 1234abd available, 5 newer configuration files available
+ user:
+ type: string
+ description: logged in user name.
+ access:
+ type: string
+ description: access level(s) of the logged in user.
signal:
type: boolean
description: whether signal is available.
@@ -237,6 +243,26 @@ components:
type: integer
description: the maximum symbol rate on the bus seen since start.
example: 167
+ minarbitrationmicros:
+ minimum: 0
+ type: integer
+ description: the minimum arbitration delay in microseconds.
+ example: 4231
+ maxarbitrationmicros:
+ minimum: 0
+ type: integer
+ description: the maximum arbitration delay in microseconds.
+ example: 4892
+ minsymbollatency:
+ minimum: 0
+ type: integer
+ description: the minimum symbol latency in milliseconds.
+ example: 4
+ maxsymbollatency:
+ minimum: 0
+ type: integer
+ description: the maximum symbol latency in milliseconds.
+ example: 9
qq:
maximum: 255
minimum: 0
@@ -263,6 +289,51 @@ components:
type: integer
description: the time in UTC seconds of the last update of any message.
example: 1493483370
+ types:
+ type: array
+ description: the known field data types (only with definition and without since).
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ description: the type name.
+ example: UCH
+ isbits:
+ type: boolean
+ description: true when the length is in bits.
+ isadjustable:
+ type: boolean
+ description: whether the length is adjustable.
+ isignored:
+ type: boolean
+ description: whether the result is ignored.
+ length:
+ type: number
+ minimum: -1
+ maximum: 31
+ description: the field length in bytes (-1 for remainder, number
+ of bits when isbits is true).
+ result:
+ enum:
+ - void
+ - string
+ - number
+ - date
+ - time
+ - datetime
+ description: the result type.
+ divisor:
+ type: number
+ description: the divisor for numeric types (only if applicable, positive
+ for divisor, negative for reciprocal i.e. 1/-divisor).
+ precision:
+ type: number
+ description: the precision (number of fraction digits) when divisor is >1.
+ required:
+ - type
+ - isbits
+ - length
Circuit:
type: object
properties:
@@ -277,14 +348,15 @@ components:
example: 8
messages:
type: object
+ description: the messages with the unique key per circuit.
additionalProperties:
$ref: '#/components/schemas/Message'
Message:
required:
- - lastup
- name
- passive
- write
+ - lastup
type: object
properties:
name:
@@ -296,6 +368,16 @@ components:
write:
type: boolean
description: true for a write message, false for a read message.
+ level:
+ type: string
+ description: the access level for the message (only with full).
+ pollprios:
+ description: the poll priority of the message (only with full).
+ type: integer
+ minimum: 0
+ condition:
+ type: string
+ description: the condition string in case of a conditional message (only with full).
lastup:
minimum: 0
type: integer
@@ -305,7 +387,7 @@ components:
maximum: 255
minimum: 0
type: integer
- description: limited source master address (only with def).
+ description: limited source master address (only with def or data).
example: 49
zz:
maximum: 255
@@ -343,6 +425,9 @@ components:
additionalProperties:
$ref: '#/components/schemas/Field'
description: the decoded fields the message is composed of (only if available).
+ decodeerror:
+ type: string
+ description: set to the error message instead of fields in case of a decoding error.
fielddefs:
type: array
description: the field definitions the message is composed of (only with
@@ -366,11 +451,11 @@ components:
description: the field comment (only with verbose).
FieldDef:
required:
- - isbits
- - length
- name
- slave
- type
+ - isbits
+ - length
type: object
properties:
name:
@@ -391,7 +476,8 @@ components:
when isbits is true).
divisor:
type: number
- description: the extra divisor applied to the raw value (only if applicable).
+ description: the divisor for numeric types (only if applicable, positive
+ for divisor, negative for reciprocal i.e. 1/-divisor).
value:
type: string
description: the constant value (only if applicable).