Commit 0019c542 authored by Rostislav Spinar's avatar Rostislav Spinar

Adding AutoNetwork schemas

parent 77ee883b
{
"$schema": "https://apidocs.iqrf.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_AutoNetwork-request",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - AutoNetwork request.",
"enum": [
"iqmeshNetwork_AutoNetwork"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"req": {
"type": "object",
"properties": {
"waves": {
"type": "integer",
"description": "Number of waves."
},
"emptyWaves": {
"type": "integer",
"description": "Number of consecutive waves, i which no new nodes were added into network."
},
"authorizeRetries": {
"type": "integer",
"description": "Number of retries to authorize new node."
},
"discoveryTxPower": {
"type": "integer",
"description": "TX power to use in discovery process."
}
},
"required": [
"waves",
"emptyWaves"
]
},
"returnVerbose": {
"type": "boolean",
"description": "Flag that includes additional parameters in the response."
}
},
"required": [
"msgId",
"req"
]
}
},
"required": [
"mType",
"data"
]
}
\ No newline at end of file
{
"$schema": "https://apidocs.iqrf.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_AutoNetwork-response",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - AutoNetwork response.",
"enum": [
"iqmeshNetwork_AutoNetwork"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"rsp": {
"type": "object",
"description": "Returns following values, see its description.",
"properties": {
"wave": {
"type": "integer",
"description": "Wave number."
},
"nodesNr": {
"type": "integer",
"description": "Number of nodes in the network."
},
"newNodesNr": {
"type": "integer",
"description": "Number of nodes newly added into the network in this wave."
},
"newNodes": {
"type": "array",
"description": "Returns nodes newly added into the network in this wave.",
"items": {
"type": "object",
"properties": {
"mid": {
"type": "string",
"description": "Module ID."
},
"address": {
"type": "integer",
"description": "Assigned address."
}
},
"required": [
"mid",
"address"
]
}
},
"lastWave": {
"type": "boolean",
"description": "Indication, if this is the last wave."
}
},
"required": [
"wave",
"nodesNr",
"newNodesNr",
"lastWave"
]
},
"raw": {
"type": "array",
"description": "Returns array of objects req-cnf-rsp, see its description.",
"items": {
"type": "object",
"properties": {
"request": {
"type": "string",
"description": "Binary buffer with DPA request."
},
"requestTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"confirmation": {
"type": "string",
"description": "Binary buffer with DPA confirmation."
},
"confirmationTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"response": {
"type": "string",
"description": "Binary buffer with DPA response."
},
"responseTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
}
},
"required": [
"request",
"requestTs",
"confirmation",
"confirmationTs",
"response",
"responseTs"
]
}
},
"insId": {
"type": "string",
"description": "IQRF GW daemon instance identification."
},
"status": {
"type": "integer",
"description": "IQRF GW daemon API (general or mType) status."
},
"statusStr": {
"type": "string",
"description": "IQRF GW daemon API (general or mType) status in string form."
}
},
"required": [
"msgId",
"status"
]
}
},
"required": [
"mType",
"data"
]
}
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment