simplified, corrected some allow empty, added defineQuery
This commit is contained in:
John
+60
-262
@@ -10,86 +10,19 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: Get all messages of all circuits.
|
summary: Get all messages of all circuits.
|
||||||
parameters:
|
parameters:
|
||||||
- name: since
|
- $ref: '#/components/parameters/sinceQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/pollQuery'
|
||||||
description: limit to messages that have changed since the specified UTC seconds.
|
- $ref: '#/components/parameters/verboseQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/indexedQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/numericQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/valuenameQuery'
|
||||||
type: integer
|
- $ref: '#/components/parameters/fullQuery'
|
||||||
- name: poll
|
- $ref: '#/components/parameters/requiredQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/writeQuery'
|
||||||
description: set the poll priority of matching message(s) to prio.
|
- $ref: '#/components/parameters/rawQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/defQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/userQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/secretQuery'
|
||||||
type: integer
|
|
||||||
- name: verbose
|
|
||||||
in: query
|
|
||||||
description: include comments and field units.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: indexed
|
|
||||||
in: query
|
|
||||||
description: always return field indexes instead of names.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: numeric
|
|
||||||
in: query
|
|
||||||
description: return numeric values of value list entries.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: valuename
|
|
||||||
in: query
|
|
||||||
description: include value and name for named values.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: full
|
|
||||||
in: query
|
|
||||||
description: include all available attributes.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: required
|
|
||||||
in: query
|
|
||||||
description: retrieve the data from the bus if not yet cached.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: write
|
|
||||||
in: query
|
|
||||||
description: retrieve write messages in addition to read/poll messages.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: raw
|
|
||||||
in: query
|
|
||||||
description: include raw master/slave data.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: def
|
|
||||||
in: query
|
|
||||||
description: include message and field definition.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
description: authenticate with user name.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: secret
|
|
||||||
in: query
|
|
||||||
description: authenticate with user secret.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Success.
|
description: Success.
|
||||||
@@ -118,92 +51,20 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: since
|
- $ref: '#/components/parameters/sinceQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/pollQuery'
|
||||||
description: limit to messages that have changed since the specified UTC seconds.
|
- $ref: '#/components/parameters/exactQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/verboseQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/indexedQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/numericQuery'
|
||||||
type: integer
|
- $ref: '#/components/parameters/valuenameQuery'
|
||||||
- name: poll
|
- $ref: '#/components/parameters/fullQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/requiredQuery'
|
||||||
description: set the poll priority of matching message(s) to prio.
|
- $ref: '#/components/parameters/writeQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/rawQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/defQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/userQuery'
|
||||||
type: integer
|
- $ref: '#/components/parameters/secretQuery'
|
||||||
- name: exact
|
|
||||||
in: query
|
|
||||||
description: exact search for circuit/message name.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: verbose
|
|
||||||
in: query
|
|
||||||
description: include comments and field units.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: indexed
|
|
||||||
in: query
|
|
||||||
description: always return field indexes instead of names.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: numeric
|
|
||||||
in: query
|
|
||||||
description: return numeric values of value list entries.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: valuename
|
|
||||||
in: query
|
|
||||||
description: include value and name for named values.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: full
|
|
||||||
in: query
|
|
||||||
description: include all available attributes.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: required
|
|
||||||
in: query
|
|
||||||
description: retrieve the data from the bus if not yet cached.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: write
|
|
||||||
in: query
|
|
||||||
description: retrieve write messages in addition to read/poll messages.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: raw
|
|
||||||
in: query
|
|
||||||
description: include raw master/slave data.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: def
|
|
||||||
in: query
|
|
||||||
description: include message and field definition.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
description: authenticate with user name.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: secret
|
|
||||||
in: query
|
|
||||||
description: authenticate with user secret.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Success.
|
description: Success.
|
||||||
@@ -237,92 +98,21 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: since
|
- $ref: '#/components/parameters/sinceQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/pollQuery'
|
||||||
description: limit to messages that have changed since the specified UTC seconds.
|
- $ref: '#/components/parameters/exactQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/verboseQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/indexedQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/numericQuery'
|
||||||
type: integer
|
- $ref: '#/components/parameters/valuenameQuery'
|
||||||
- name: poll
|
- $ref: '#/components/parameters/fullQuery'
|
||||||
in: query
|
- $ref: '#/components/parameters/requiredQuery'
|
||||||
description: set the poll priority of matching message(s) to prio.
|
- $ref: '#/components/parameters/writeQuery'
|
||||||
allowEmptyValue: false
|
- $ref: '#/components/parameters/rawQuery'
|
||||||
schema:
|
- $ref: '#/components/parameters/defQuery'
|
||||||
minimum: 0
|
- $ref: '#/components/parameters/defineQuery'
|
||||||
type: integer
|
- $ref: '#/components/parameters/userQuery'
|
||||||
- name: exact
|
- $ref: '#/components/parameters/secretQuery'
|
||||||
in: query
|
|
||||||
description: exact search for circuit/message name.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: verbose
|
|
||||||
in: query
|
|
||||||
description: include comments and field units.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: indexed
|
|
||||||
in: query
|
|
||||||
description: always return field indexes instead of names.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: numeric
|
|
||||||
in: query
|
|
||||||
description: return numeric values of value list entries.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: valuename
|
|
||||||
in: query
|
|
||||||
description: include value and name for named values.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: full
|
|
||||||
in: query
|
|
||||||
description: include all available attributes.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: required
|
|
||||||
in: query
|
|
||||||
description: retrieve the data from the bus if not yet cached.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: write
|
|
||||||
in: query
|
|
||||||
description: retrieve write messages in addition to read/poll messages.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: raw
|
|
||||||
in: query
|
|
||||||
description: include raw master/slave data.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: def
|
|
||||||
in: query
|
|
||||||
description: include message and field definition.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
description: authenticate with user name.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: secret
|
|
||||||
in: query
|
|
||||||
description: authenticate with user secret.
|
|
||||||
allowEmptyValue: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Success
|
description: Success
|
||||||
@@ -676,72 +466,80 @@ components:
|
|||||||
name: exact
|
name: exact
|
||||||
in: query
|
in: query
|
||||||
description: exact search for circuit/message name.
|
description: exact search for circuit/message name.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
verboseQuery:
|
verboseQuery:
|
||||||
name: verbose
|
name: verbose
|
||||||
in: query
|
in: query
|
||||||
description: include comments and field units.
|
description: include comments and field units.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
indexedQuery:
|
indexedQuery:
|
||||||
name: indexed
|
name: indexed
|
||||||
in: query
|
in: query
|
||||||
description: always return field indexes instead of names.
|
description: always return field indexes instead of names.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
numericQuery:
|
numericQuery:
|
||||||
name: numeric
|
name: numeric
|
||||||
in: query
|
in: query
|
||||||
description: return numeric values of value list entries.
|
description: return numeric values of value list entries.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
valuenameQuery:
|
valuenameQuery:
|
||||||
name: valuename
|
name: valuename
|
||||||
in: query
|
in: query
|
||||||
description: include value and name for named values.
|
description: include value and name for named values.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
fullQuery:
|
fullQuery:
|
||||||
name: full
|
name: full
|
||||||
in: query
|
in: query
|
||||||
description: include all available attributes.
|
description: include all available attributes.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
requiredQuery:
|
requiredQuery:
|
||||||
name: required
|
name: required
|
||||||
in: query
|
in: query
|
||||||
description: retrieve the data from the bus if not yet cached.
|
description: retrieve the data from the bus if not yet cached.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
writeQuery:
|
writeQuery:
|
||||||
name: write
|
name: write
|
||||||
in: query
|
in: query
|
||||||
description: retrieve write messages in addition to read/poll messages.
|
description: retrieve write messages in addition to read/poll messages.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
rawQuery:
|
rawQuery:
|
||||||
name: raw
|
name: raw
|
||||||
in: query
|
in: query
|
||||||
description: include raw master/slave data.
|
description: include raw master/slave data.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
defQuery:
|
defQuery:
|
||||||
name: def
|
name: def
|
||||||
in: query
|
in: query
|
||||||
description: include message and field definition.
|
description: include message and field definition.
|
||||||
allowEmptyValue: false
|
allowEmptyValue: true
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
defineQuery:
|
||||||
|
name: define
|
||||||
|
in: query
|
||||||
|
description: update/replace a message definition.
|
||||||
|
allowEmptyValue: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: message definition in CSV format.
|
||||||
userQuery:
|
userQuery:
|
||||||
name: user
|
name: user
|
||||||
in: query
|
in: query
|
||||||
|
|||||||
Reference in New Issue
Block a user