diff --git a/OpenAPI/openapi-AE2.yaml b/OpenAPI/openapi-AE2.yaml new file mode 100644 index 0000000000000000000000000000000000000000..88de3be0a0febaaec2779812c0c3869b5aa9fee0 --- /dev/null +++ b/OpenAPI/openapi-AE2.yaml @@ -0,0 +1,302 @@ +--- +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: |- + { + "m2m:ae" : { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://cse-address:8080"] + } + } + responses: + '201': + description: Create AE Response + content: + application/json: + examples: + with no rcn or rcn=1 in the request: + value: |- + { + "m2m:ae": { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://cse-address:8080"], + "ri": "CAdmin", + "ct": "20210330T153934,791690", + "lt": "20210330T153934,791690", + "et": "20220330T153934,791714", + "pi": "cse-id", + "ty": 2, + "aei": "CAdmin" + } + } + 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: |- + { + "m2m:ae": { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://cse-address:8080"], + "ri": "CAdmin", + "ct": "20210330T153934,791690", + "lt": "20210330T153934,791690", + "et": "20220330T153934,791714", + "pi": "cse-id", + "ty": 2, + "aei": "CAdmin" + } + } + 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: |- + { + "m2m:ae" : { + "lbl": ["aename bedroom"], + "poa": ["http://192.168.1.50:9090"] + } + } + responses: + '200': + description: Update AE Response + content: + application/json: + examples: + with no rcn or rcn=1 in the request: + value: |- + { + "m2m:ae": { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["aename bedroom"], + "rr": true, + "srv": ["3"], + "poa": ["http://192.168.1.50:9090"], + "ri": "CAdmin", + "ct": "20210406T171115,934044", + "lt": "20210407T080109,896281", + "et": "20220406T171115,934064", + "pi": "cse-id", + "ty": 2, + "aei": "CAdmin" + } + } + 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: |- + { + "m2m:ae": { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://cse-address:8080"], + "ri": "C8r12WReyGd", + "ct": "20210407T090236,657104", + "lt": "20210407T090236,657104", + "et": "20220407T090236,657145", + "pi": "cse-id", + "ty": 2, + "aei": "C8r12WReyGd" + } + } + servers: + - url: http://cse-address:8080 + servers: + - url: http://cse-address:8080 diff --git a/OpenAPI/openapi-AE3.yaml b/OpenAPI/openapi-AE3.yaml new file mode 100644 index 0000000000000000000000000000000000000000..ce769002ba292de54ddce8d18c7154f5adf7e430 --- /dev/null +++ b/OpenAPI/openapi-AE3.yaml @@ -0,0 +1,195 @@ +openapi: 3.0.1 +info: + title: defaultTitle + description: defaultDescription + version: '0.1' +servers: + - url: 'http://192.168.1.30:8080' +paths: + /cse-in: + post: + description: Auto generated using Swagger Inspector + parameters: + - name: X-M2M-Origin + in: header + schema: + type: string + example: CAdmin + - name: X-M2M-RVI + in: header + schema: + type: string + example: '3' + - name: X-M2M-RI + in: header + schema: + type: string + example: '1234' + requestBody: + content: + application/json;ty=2: + schema: + type: object + examples: + '0': + value: |- + { + "m2m:ae" : { + "rn": "temperature", + "api": "N01.com.company.temperature ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://192.168.1.30:8080"] + } + } + responses: + '201': + description: "create AE" + content: + application/json: + schema: + type: object + properties: + 'm2m:ae': + type: object + properties: + rr: + type: boolean + poa: + type: array + items: + type: string + aei: + type: string + ty: + type: integer + lt: + type: string + et: + type: string + ct: + type: string + srv: + type: array + items: + type: string + lbl: + type: array + items: + type: string + ri: + type: string + pi: + type: string + api: + type: string + rn: + type: string + examples: + 'rcn=0': + value: >- + {"m2m:ae": {"rn": "temperature", "api": + "N01.com.company.temperature ", "lbl": ["key1", "key2"], + "rr": true, "srv": ["3"], "poa": + ["http://192.168.1.30:8080"], "ri": "CAdmin", "ct": + "20210330T153934,791690", "lt": "20210330T153934,791690", + "et": "20220330T153934,791714", "pi": "id-in", "ty": 2, + "aei": "CAdmin"}} + 'rcn=2': + value: >- + {"m2m:ae": {"rn": "temperature", "api": + "N01.com.company.temperature ", "lbl": ["key1", "key2"], + "rr": true, "srv": ["3"], "poa": + ["http://192.168.1.30:8080"], "ri": "CAdmin", "ct": + "20210330T153934,791690", "lt": "20210330T153934,791690", + "et": "20220330T153934,791714", "pi": "id-in", "ty": 2, + "aei": "CAdmin"}} + servers: + - url: 'http://192.168.1.30:8080' + servers: + - url: 'http://192.168.1.30:8080' + /cse-in/temperature: + get: + description: Auto generated using Swagger Inspector + parameters: + - name: X-M2M-Origin + in: header + schema: + type: string + example: CAdmin + - name: X-M2M-RVI + in: header + schema: + type: string + example: '3' + - name: X-M2M-RI + in: header + schema: + type: string + example: '1234' + responses: + '200': + description: Auto generated using Swagger Inspector + content: + application/json: + schema: + type: object + properties: + 'm2m:ae': + type: object + properties: + rr: + type: boolean + poa: + type: array + items: + type: string + aei: + type: string + ty: + type: integer + lt: + type: string + et: + type: string + ct: + type: string + srv: + type: array + items: + type: string + lbl: + type: array + items: + type: string + ri: + type: string + pi: + type: string + api: + type: string + rn: + type: string + examples: + '0': + value: >- + {"m2m:ae": {"rn": "temperature", "api": + "N01.com.company.temperature ", "lbl": ["key1", "key2"], + "rr": true, "srv": ["3"], "poa": + ["http://192.168.1.30:8080"], "ri": "CAdmin", "ct": + "20210330T153934,791690", "lt": "20210330T153934,791690", + "et": "20220330T153934,791714", "pi": "id-in", "ty": 2, + "aei": "CAdmin"}} + servers: + - url: 'http://192.168.1.30:8080' + servers: + - url: 'http://192.168.1.30:8080' +components: + schemas: + Schema: + type: object + properties: + id: + type: integer + format: int64 \ No newline at end of file