openapi-AE4.yaml 11.5 KB
Newer Older
Laurent Velez's avatar
test1  
Laurent Velez committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
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:
Laurent Velez's avatar
test2  
Laurent Velez committed
56
        201:
Laurent Velez's avatar
test1  
Laurent Velez committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
          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:
Laurent Velez's avatar
test3  
Laurent Velez committed
83
                  value: ''                
Laurent Velez's avatar
test1  
Laurent Velez committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
                rcn=3 in the request:
                  value: |-
                    {
                        "m2m:rce": {
                            "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"
                                },
                                   "uri": "csename/aename"
Laurent Velez's avatar
test3  
Laurent Velez committed
104
                            }
Laurent Velez's avatar
test1  
Laurent Velez committed
105 106 107
                        }
                             
                    }
Laurent Velez's avatar
test2  
Laurent Velez committed
108 109 110 111 112 113
                rcn=2 in the request:
                  value: |-
                    {
                        "m2m:ae": "csename/aename"
                                   
                    }          
Laurent Velez's avatar
test1  
Laurent Velez committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
      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'