Skip to content
Snippets Groups Projects
openapi.yaml 23 KiB
Newer Older
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 56 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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
openapi: 3.0.3
info:
  title: SmartDataContext API
  version: 0.1.0
  description: API to manage SmartDataContext entities.
paths:
  /api/v1_1/context.php#create:
    post:
      summary: Creates a new SmartDataContext
      requestBody:
        description: Create a new SmartDataContext with the given parameters.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  example: "/create"
                  description: The command to be executed.
                request:
                  type: object
                  properties:
                    smartDataUnits:
                      type: array
                      items:
                        type: integer
                      description: The values of the SmartDataUnits to associate with this SmartDataContext.
                      example: [98812]
                    smartDataSources:
                      type: array
                      items:
                        oneOf:
                          - type: string
                          - type: array
                            items:
                              type: integer
                      description: The signatures (mobile) or space sphere (stationary) of the SmartDataSources associated with this context.
                      example: ["signature", [1, 1, 1, 1]]
                    t0:
                      type: integer
                      description: If not informed, assumed -1 as the value.
                      example: 1
                    t1:
                      type: integer
                      description: If not informed, assumed -1 as the value.
                      example: 1
                    features:
                      type: object
                      description: At least a single feature "tags" with at least one tag should be provided.
                      properties:
                        tags:
                          type: array
                          items:
                            type: string
                          example: ["sim"]
                    content:
                      type: object
                      description: The JSON of the SmartDataContext to be stored.
                      example: {"meta": true}
              required:
                - command
                - request
      responses:
        '200':
          description: The id for the created SmartDataContext.
          content:
            application/json:
              schema:
                type: object
                properties:
                  smartdatacontextid:
                    type: string
                    example: "zzz-eee-ddd"
                    description: The ID of the created SmartDataContext.
                  errors:
                    type: array
                    example: ["Invalid id"]
                    description: "Present if errors ocurred during the request."
  /api/v1_1/context.php#associate:
    post:
      summary: Associates SmartDataUnits or SmartDataSources to a SmartDataContext
      operationId: associateSmartDataContext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  example: /associate
                request:
                  type: object
                  properties:
                    smartDataUnits:
                      type: array
                      items:
                        type: integer
                      description: The values of the SmartDataUnits to associate with this SmartDataContext
                    smartDataSources:
                      type: array
                      items:
                        oneOf:
                          - type: string
                          - type: array
                            items:
                              type: integer
                      description: The signatures (mobile) or space sphere (stationary) of the SmartDataSources to associate with this context
                    smartDataContextIds:
                      type: array
                      items:
                        type: string
                      description: A list of SmartDataContext IDs to associate
                  required:
                    - smartDataContextIds
                  oneOf:
                    - required:
                        - smartDataUnits
                    - required:
                        - smartDataSources
                  example:
                    smartDataUnits: [98812]
                    smartDataSources: ["signature", [1,1,1,1]]
                    smartDataContextIds: ['u3iu48-34323-d343-rffe', 'u3iu48-34323-d343-rffe']
      responses:
        '200':
          description: Update SmartDataContext entities or list of errors
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            success:
                              type: boolean
                            result:
                              type: object
                              properties:
                                _id:
                                  type: object
                                  properties:
                                    $oid:
                                      type: string
                                      example: "66c351f6fb8347b8c406db52"
                                id:
                                  type: string
                                  example: "88690087-a4f4-4e1d-8c8d-8c67d19ddaed"
                                t0:
                                  type: integer
                                  example: -1
                                t1:
                                  type: integer
                                  example: -1
                                content:
                                  type: object
                                  properties:
                                    meta:
                                      type: boolean
                                      example: true
                                features:
                                  type: object
                                  properties:
                                    tags:
                                      type: array
                                      items:
                                        type: string
                                        example: "sim"
                                    identifier:
                                      type: string
                                      example: "0d8c9a721e46a26f31acce9a714620510c1722d1"
                                smartDataSources:
                                  type: array
                                  items:
                                    oneOf:
                                      - type: string
                                      - type: array
                                        items:
                                          type: integer
                                smartDataUnits:
                                  type: array
                                  items:
                                    type: integer
                                    example: 111
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            errors:
                              type: array
                              items:
                                type: string
                                example: "Invalid id"


  /api/v1_1/context.php#unassociate:
    post:
      summary: Unassociate SmartDataUnits or SmartDataSources from SmartDataContext
      operationId: unassociateSmartDataContext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  example: /unassociate
                request:
                  type: object
                  properties:
                    smartDataUnits:
                      type: array
                      items:
                        type: integer
                      description: The values of the SmartDataUnits to unassociate with this SmartDataContext
                    smartDataSources:
                      type: array
                      items:
                        oneOf:
                          - type: string
                          - type: array
                            items:
                              type: integer
                      description: The signatures (mobile) or space sphere (stationary) of the SmartDataSources to unassociate with this context
                    smartdataids:
                      type: array
                      items:
                        type: string
                      description: A list of SmartData IDs to unassociate
                  required:
                    - smartdataids
                  oneOf:
                    - required:
                        - smartDataUnits
                    - required:
                        - smartDataSources
                  example:
                    smartDataUnits: [98812]
                    smartDataSources: ["signature", [1,1,1,1]]
                    smartdataids: ['u3iu48-34323-d343-rffe', 'u3iu48-34323-d343-rffe']
      responses:
        '200':
          description: Update SmartDataContext entities or list of errors
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            success:
                              type: boolean
                            result:
                              type: object
                              properties:
                                _id:
                                  type: object
                                  properties:
                                    $oid:
                                      type: string
                                      example: "66c351f6fb8347b8c406db52"
                                id:
                                  type: string
                                  example: "88690087-a4f4-4e1d-8c8d-8c67d19ddaed"
                                t0:
                                  type: integer
                                  example: -1
                                t1:
                                  type: integer
                                  example: -1
                                content:
                                  type: object
                                  properties:
                                    meta:
                                      type: boolean
                                      example: true
                                features:
                                  type: object
                                  properties:
                                    tags:
                                      type: array
                                      items:
                                        type: string
                                        example: "sim"
                                    identifier:
                                      type: string
                                      example: "0d8c9a721e46a26f31acce9a714620510c1722d1"
                                smartDataSources:
                                  type: array
                                  items:
                                    oneOf:
                                      - type: string
                                      - type: array
                                        items:
                                          type: integer
                                smartDataUnits:
                                  type: array
                                  items:
                                    type: integer
                                    example: 111
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            errors:
                              type: array
                              items:
                                type: string
                                example: "Invalid id"

  /api/v1_1/context.php#context:
    post:
      summary: Retrieve context data for a given SmartData Unit or SmartDataSource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  example: /contexts
                  description: The command to execute.
                request:
                  type: object
                  properties:
                    smartDataSources:
                      type: array
                      items:
                        type: array
                        items:
                          type: integer
                      description: An array of smart data source arrays.
                      example: [[4,5,6,7]]
                    smartDataUnits:
                      type: array
                      items:
                        type: integer
                      description: A list of smart data unit IDs.
                      example: [111]
                    t0:
                      type: integer
                      description: Start time for the query.
                      example: 10
                    t1:
                      type: integer
                      description: End time for the query.
                      example: 300
              required:
                - command
                - request
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      _id:
                        type: object
                        properties:
                          $oid:
                            type: string
                            example: "66c351f6fb8347b8c406db52"
                      id:
                        type: string
                        example: "88690087-a4f4-4e1d-8c8d-8c67d19ddaed"
                      t0:
                        type: integer
                        example: -1
                      t1:
                        type: integer
                        example: -1
                      content:
                        type: object
                        properties:
                          meta:
                            type: boolean
                            example: true
                      features:
                        type: object
                        properties:
                          tags:
                            type: array
                            items:
                              type: string
                            example: ["sim"]
                          identifier:
                            type: string
                            example: "0d8c9a721e46a26f31acce9a714620510c1722d1"
                      smartDataSources:
                        type: array
                        items:
                          oneOf:
                            - type: string
                            - type: array
                              items:
                                type: integer
                        example:
                          - "ffdaf2342"
                          - [1, 2, 3, 5]
                          - "ae7666"
                          - [4, 5, 6, 7]
                      smartDataUnits:
                        type: array
                        items:
                          type: integer
                        example: [111, 222]

        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example: ["Invalid id"]
  /api/v1_1/context.php#query:
    post:
      summary: Execute a MongoDB query over the SmartDataContext entities
      description: Endpoint to execute a MongoDB query and retrieve results.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - command
                - request
              properties:
                command:
                  type: string
                  description: Specifies the type of command to execute.
                  example: "/query"
                request:
                  type: object
                  description: A MongoDB query should be passed here.
      responses:
        '200':
          description: The MongoDB query result
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    description: Response object containing the result
        '400':
          description: A list of errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example: ["Invalid id"]
  /api/v1_1/context.php#update:
    post:
      summary: Updates an existing SmartDataContext
      description: Updates the properties of an existing SmartDataContext using the provided ID and request body.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  description: The command to update a SmartDataContext, including the ID.
                  example: "/update/88690087-a4f4-4e1d-8c8d-8c67d19ddaed"
                request:
                  type: object
                  description: The object containing the properties to be updated in the SmartDataContext.
                  properties:
                    domain:
                      type: string
                      description: The domain of the SmartDataContext.
                      example: "test"
                    t0:
                      type: integer
                      description: Start time for the SmartDataContext.
                      example: 1000
                    t1:
                      type: integer
                      description: End time for the SmartDataContext.
                      example: 2000
                    content:
                      type: object
                      description: The content to be updated in the SmartDataContext.
                      example: {"meta": "updated"}
                    features:
                      type: object
                      description: Updated features of the SmartDataContext.
                      properties:
                        tags:
                          type: array
                          items:
                            type: string
                          example: ["newtag"]
                    smartDataSources:
                      type: array
                      items:
                        oneOf:
                          - type: string
                          - type: array
                            items:
                              type: integer
                      description: The updated SmartDataSources.
                      example: ["signature", [2, 2, 2, 2]]
                    smartDataUnits:
                      type: array
                      items:
                        type: integer
                      description: The updated SmartDataUnits.
                      example: [20, 22]
              required:
                - command
                - request
      responses:
        '200':
          description: Successfully updated SmartDataContext.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "88690087-a4f4-4e1d-8c8d-8c67d19ddaed"
                      t0:
                        type: integer
                        example: 1000
                      t1:
                        type: integer
                        example: 2000
                      content:
                        type: object
                        properties:
                          meta:
                            type: string
                            example: "updated"
                      features:
                        type: object
                        properties:
                          tags:
                            type: array
                            items:
                              type: string
                            example: ["newtag"]
                      smartDataSources:
                        type: array
                        items:
                          oneOf:
                            - type: string
                            - type: array
                              items:
                                type: integer
                        example: ["signature", [2, 2, 2, 2]]
                      smartDataUnits:
                        type: array
                        items:
                          type: integer
                        example: [20, 22]
        '400':
          description: Invalid request due to validation errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example: ["Invalid command format", "Both t0 and t1 must be set together"]