diff --git a/OpenAPI/openapi-AE4.yaml b/OpenAPI/openapi-AE4.yaml index 40af78fdc46a4436d201b682b4d09bc66d1ff80c..7905662aefbef7173f75f791b57f516a989c389e 100644 --- a/OpenAPI/openapi-AE4.yaml +++ b/OpenAPI/openapi-AE4.yaml @@ -111,51 +111,7 @@ paths: "m2m:ae": "csename/aename" } - with rcn=4 in the request: - value: |- - { - "m2m:rce": { - "rn": "aename", - "api": "N01.com.company.aename ", - "lbl": ["key1", "key2"], - "rr": true, - "srv": ["3"], - "poa": ["http://cse-address:8080"], - "ri": "CAdmin", - "ct": "20210406T171115,934044", - "lt": "20210406T171115,934044", - "et": "20220406T171115,934064", - "pi": "cse-id", - "ty": 2, - "aei": "CAdmin", - "m2m:cnt": - [{"rn": "data1", - "lbl": ["API"], - "ri": "cnt7407517254520235341", - "ct": "20210407T073116,754629", - "lt": "20210407T073116,754629", - "et": "20220407T073116,754662", - "pi": "CAdmin", - "st": 0, - "ty": 3, - "cni": 0, - "cbs": 0 - }, - { - "rn": "data2", - "lbl": ["API2"], - "ri": "cnt446121489468649928", - "ct": "20210407T073158,811116", - "lt": "20210407T073158,811116", - "et": "20220407T073158,811187", - "pi": "CAdmin", - "st": 0, - "ty": 3, - "cni": 0, - "cbs": 0 - }] - } - } + servers: - url: 'http://cse-address:8080' servers: diff --git a/OpenAPI/openapi-AE5.yaml b/OpenAPI/openapi-AE5.yaml new file mode 100644 index 0000000000000000000000000000000000000000..4ce53a40afc5f03b3967a4ac4ea5f4e764782f2e --- /dev/null +++ b/OpenAPI/openapi-AE5.yaml @@ -0,0 +1,346 @@ +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: true + 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: object + 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: + schema: + type: object + 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=3 in the request': + value: |- + { + "m2m:rce" { + "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" + } + "uri": "mn-name/ae_sensor" + + } + + } + 'rcn=2 in the request': + value: |- + { + "m2m:ae": "csename/aename" + + } + + 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: true + 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: |- + { + "m2m:ae": { + "rn": "aename", + "api": "N01.com.company.aename ", + "lbl": ["key1", "key2"], + "rr": true, + "srv": ["3"], + "poa": ["http://cse-address:8080"], + "ri": "CAdmin", + "ct": "20210406T171115,934044", + "lt": "20210406T171115,934044", + "et": "20220406T171115,934064", + "pi": "cse-id", + "ty": 2, + "aei": "CAdmin", + "m2m:cnt": + [{"rn": "data1", + "lbl": ["API"], + "ri": "cnt7407517254520235341", + "ct": "20210407T073116,754629", + "lt": "20210407T073116,754629", + "et": "20220407T073116,754662", + "pi": "CAdmin", + "st": 0, + "ty": 3, + "cni": 0, + "cbs": 0 + }, + { + "rn": "data2", + "lbl": ["API2"], + "ri": "cnt446121489468649928", + "ct": "20210407T073158,811116", + "lt": "20210407T073158,811116", + "et": "20220407T073158,811187", + "pi": "CAdmin", + "st": 0, + "ty": 3, + "cni": 0, + "cbs": 0 + }] + } + } + 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'