diff options
Diffstat (limited to 'xds-service/xds-service-apidef.json')
-rw-r--r-- | xds-service/xds-service-apidef.json | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/xds-service/xds-service-apidef.json b/xds-service/xds-service-apidef.json new file mode 100644 index 0000000..76e35b7 --- /dev/null +++ b/xds-service/xds-service-apidef.json @@ -0,0 +1,152 @@ +{ + "openapi": "3.0.0", + "$schema": "http://iot.bzh/download/openapi/schema-3.0/default-schema.json", + "info": { + "description": "TBD - TODO", + "title": "xds-service", + "version": "4.0", + "x-binding-c-generator": { + "api": "xds-service", + "version": 2, + "prefix": "", + "postfix": "", + "start": null, + "onevent": "xds_event_cb", + "init": "init", + "scope": "", + "private": false + } + }, + "servers": [{}], + "components": { + "schemas": { + "afb-reply": { + "$ref": "#/components/schemas/afb-reply-v2" + }, + "afb-event": { + "$ref": "#/components/schemas/afb-event-v2" + }, + "afb-reply-v2": { + "title": "Generic response.", + "type": "object", + "required": ["jtype", "request"], + "properties": { + "jtype": { + "type": "string", + "const": "afb-reply" + }, + "request": { + "type": "object", + "required": ["status"], + "properties": { + "status": { + "type": "string" + }, + "info": { + "type": "string" + }, + "token": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "reqid": { + "type": "string" + } + } + }, + "response": { + "type": "object" + } + } + }, + "afb-event-v2": { + "type": "object", + "required": ["jtype", "event"], + "properties": { + "jtype": { + "type": "string", + "const": "afb-event" + }, + "event": { + "type": "string" + }, + "data": { + "type": "object" + } + } + } + }, + "x-permissions": { + "list": { + "permission": "urn:AGL:permission::platform:can:list " + }, + "trace": { + "permission": "urn:AGL:permission::platform:can:trace " + } + }, + "responses": { + "200": { + "description": "A complex object array response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/afb-reply" + } + } + } + } + } + }, + "paths": { + "/auth": { + "description": "Authenticate session to raise Level Of Assurance of the session", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/list" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200" + } + } + } + }, + "/list": { + "description": "list ", + "get": { + "x-permissions": { + "LOA": 1 + }, + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/200" + } + } + } + }, + "/trace": { + "description": "trace ", + "get": { + "x-permissions": { + "LOA": 1 + }, + "parameters": [{ + "in": "query", + "name": "ws", + "required": true, + "schema": { + "type": "string" + } + }], + "responses": { + "200": { + "$ref": "#/components/responses/200" + } + } + } + } + } +} |