diff --git a/OpenAPI/openapi-API-AE.json b/OpenAPI/openapi-API-AE.json new file mode 100644 index 0000000000000000000000000000000000000000..5a027c699bf0dfe392b27be2b87d924f6999b1e8 --- /dev/null +++ b/OpenAPI/openapi-API-AE.json @@ -0,0 +1,305 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "AE", + "description": "API for AE resource management", + "version": "0.1" + }, + "servers": [{ + "url": "http://cse-address:8080" + }], + "paths": { + + "/csename": { + "post": { + "description": "Create AE Resource", + "parameters": [{ + "name": "X-M2M-Origin", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "CAdmin" + }, + { + "name": "X-M2M-RVI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "3" + }, + { + "name": "X-M2M-RI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "1234" + } + ], + "requestBody": { + "content": { + "application/json;ty=2": { + "schema": { + "type": "string" + }, + "examples": { + "0": { + "value": "{\n \"m2m:ae\" : {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"]\n }\n}" + } + } + } + } + }, + "responses": { + "201": { + "description": "Create AE Response", + "content": { + "application/json": { + + "examples": { + "with no rcn or rcn=1 in the request": { + "value": "{\n \"m2m:ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"],\n \"ri\": \"CAdmin\",\n \"ct\": \"20210330T153934,791690\",\n \"lt\": \"20210330T153934,791690\",\n \"et\": \"20220330T153934,791714\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"CAdmin\"\n }\n}" + }, + "rcn=0 in the request": { + "value": " " + }, + "rcn=2 in the request": { + "value": "{\n \"m2m:ae\": \"csename/aename\"\n \n}" + }, + "rcn=3 in the request": { + "value": "{\n \"m2m:rce\": {\n \"ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"],\n \"ri\": \"CAdmin\",\n \"ct\": \"20210406T171115,934044\",\n \"lt\": \"20210406T171115,934044\",\n \"et\": \"20220406T171115,934064\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"CAdmin\"\n },\n \"uri\": \"csename/aename\"\n }\n }\n \n}" + } + + } + } + } + } + }, + "servers": [{ + "url": "http://cse-address:8080" + }] + }, + "servers": [{ + "url": "http://cse-address:8080" + }] + }, + + + + "/csename/aename": { + "get": { + "description": "Retrieve AE Resource", + "parameters": [{ + "name": "X-M2M-Origin", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "CAdmin" + }, + { + "name": "X-M2M-RVI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "3" + }, + { + "name": "X-M2M-RI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "1234" + } + ], + "responses": { + "200": { + "description": "Retrieve AE Response", + "content": { + "application/json": { + + "examples": { + "with no rcn or rcn=1 in the request": { + "value": "{\n \"m2m:ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"],\n \"ri\": \"CAdmin\",\n \"ct\": \"20210330T153934,791690\",\n \"lt\": \"20210330T153934,791690\",\n \"et\": \"20220330T153934,791714\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"CAdmin\"\n }\n}" + }, + + "with rcn=4 in the request": { + "value": "{\n \"m2m:ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"],\n \"ri\": \"CAdmin\",\n \"ct\": \"20210406T171115,934044\",\n \"lt\": \"20210406T171115,934044\",\n \"et\": \"20220406T171115,934064\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"CAdmin\",\n \"m2m:cnt\": \n [{\"rn\": \"data1\",\n \"lbl\": [\"API\"],\n \"ri\": \"cnt7407517254520235341\",\n \"ct\": \"20210407T073116,754629\",\n \"lt\": \"20210407T073116,754629\",\n \"et\": \"20220407T073116,754662\",\n \"pi\": \"CAdmin\",\n \"st\": 0,\n \"ty\": 3,\n \"cni\": 0,\n \"cbs\": 0\n },\n {\n \"rn\": \"data2\",\n \"lbl\": [\"API2\"],\n \"ri\": \"cnt446121489468649928\",\n \"ct\": \"20210407T073158,811116\",\n \"lt\": \"20210407T073158,811116\",\n \"et\": \"20220407T073158,811187\",\n \"pi\": \"CAdmin\",\n \"st\": 0,\n \"ty\": 3,\n \"cni\": 0,\n \"cbs\": 0\n }]\n}\n}" + } + } + } + } + } + }, + "servers": [{ + "url": "http://cse-address:8080" + }] + }, + "put": { + "description": "Update AE resource", + "parameters": [{ + "name": "X-M2M-Origin", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "CAdmin" + }, + { + "name": "X-M2M-RVI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "3" + }, + { + "name": "X-M2M-RI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "1234" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "0": { + "value": "{\n \"m2m:ae\" : {\n \"lbl\": [\"aename bedroom\"],\n \"poa\": [\"http://192.168.1.50:9090\"]\n }\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Update AE Response", + "content": { + "application/json": { + + "examples": { + "with no rcn or rcn=1 in the request": { + "value": "{\n \"m2m:ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"aename bedroom\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://192.168.1.50:9090\"],\n \"ri\": \"CAdmin\",\n \"ct\": \"20210406T171115,934044\",\n \"lt\": \"20210407T080109,896281\",\n \"et\": \"20220406T171115,934064\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"CAdmin\"\n }\n}" + }, + "with rcn=0 in the request": { + "value": "" + } + } + } + } + } + }, + "servers": [{ + "url": "http://cse-address:8080" + }] + }, + + "delete": { + "description": "Delete AE", + "parameters": [{ + "name": "X-M2M-Origin", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "CAdmin" + }, + { + "name": "X-M2M-RVI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "3" + }, + { + "name": "X-M2M-RI", + "in": "header", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + }, + "example": "1234" + } + ], + "responses": { + "200": { + "description": "Delete AE response", + "content": { + "application/json": { + + "examples": { + "with no rcn or rcn=0 in the request": { + "value": "" + }, + "with rcn=1 in the request": { + "value": "{\n \"m2m:ae\": {\n \"rn\": \"aename\",\n \"api\": \"N01.com.company.aename \",\n \"lbl\": [\"key1\", \"key2\"],\n \"rr\": true,\n \"srv\": [\"3\"],\n \"poa\": [\"http://cse-address:8080\"],\n \"ri\": \"C8r12WReyGd\",\n \"ct\": \"20210407T090236,657104\",\n \"lt\": \"20210407T090236,657104\",\n \"et\": \"20220407T090236,657145\",\n \"pi\": \"cse-id\",\n \"ty\": 2,\n \"aei\": \"C8r12WReyGd\"\n }\n}" + } + } + } + } + } + + + + }, + "servers": [{ + "url": "http://cse-address:8080" + }] + }, + + "servers": [{ + "url": "http://cse-address:8080" + }] + } + + + + + } + +} \ No newline at end of file