PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 1 | swagger: '2.0' |
| 2 | info: |
| 3 | description: This page lists all the rest apis for the service. |
| 4 | version: '1.0' |
| 5 | title: Enrichment Data service |
| 6 | host: 'localhost:8081' |
| 7 | basePath: / |
| 8 | tags: |
| 9 | - name: A1-E Enrichment Data Consumer API |
| 10 | description: Consumer Controller |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 11 | - name: Enrichment Data Producer API |
| 12 | description: Producer Controller |
| 13 | - name: Producer Simulator |
| 14 | description: Producer Simulator Controller |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 15 | paths: |
| 16 | /A1-EI/v1/eitypes: |
| 17 | get: |
| 18 | tags: |
| 19 | - A1-E Enrichment Data Consumer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 20 | summary: EI type identifiers |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 21 | operationId: getEiTypeIdentifiersUsingGET |
| 22 | produces: |
| 23 | - application/json |
| 24 | responses: |
| 25 | '200': |
| 26 | description: EI type identifiers |
| 27 | schema: |
| 28 | type: array |
| 29 | items: |
| 30 | type: string |
| 31 | '401': |
| 32 | description: Unauthorized |
| 33 | '403': |
| 34 | description: Forbidden |
| 35 | '404': |
| 36 | description: Not Found |
| 37 | deprecated: false |
| 38 | '/A1-EI/v1/eitypes/{eiTypeId}': |
| 39 | get: |
| 40 | tags: |
| 41 | - A1-E Enrichment Data Consumer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 42 | summary: Individual EI type |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 43 | operationId: getEiTypeUsingGET |
| 44 | produces: |
| 45 | - application/json |
| 46 | parameters: |
| 47 | - name: eiTypeId |
| 48 | in: path |
| 49 | description: eiTypeId |
| 50 | required: true |
| 51 | type: string |
| 52 | responses: |
| 53 | '200': |
| 54 | description: EI type |
| 55 | schema: |
| 56 | $ref: '#/definitions/ei_type_info' |
| 57 | '401': |
| 58 | description: Unauthorized |
| 59 | '403': |
| 60 | description: Forbidden |
| 61 | '404': |
| 62 | description: Enrichment Information type is not found |
| 63 | schema: |
| 64 | $ref: '#/definitions/error_information' |
| 65 | deprecated: false |
| 66 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs': |
| 67 | get: |
| 68 | tags: |
| 69 | - A1-E Enrichment Data Consumer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 70 | summary: EI job identifiers |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 71 | operationId: getEiJobIdsUsingGET |
| 72 | produces: |
| 73 | - application/json |
| 74 | parameters: |
| 75 | - name: eiTypeId |
| 76 | in: path |
| 77 | description: eiTypeId |
| 78 | required: true |
| 79 | type: string |
| 80 | - in: body |
| 81 | name: owner |
| 82 | description: identifies the owner of the job |
| 83 | required: false |
| 84 | schema: |
| 85 | type: string |
| 86 | responses: |
| 87 | '200': |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 88 | description: EI job identifiers |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 89 | schema: |
| 90 | type: array |
| 91 | items: |
| 92 | type: string |
| 93 | '401': |
| 94 | description: Unauthorized |
| 95 | '403': |
| 96 | description: Forbidden |
| 97 | '404': |
| 98 | description: Enrichment Information type is not found |
| 99 | schema: |
| 100 | $ref: '#/definitions/error_information' |
| 101 | deprecated: false |
| 102 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}': |
| 103 | get: |
| 104 | tags: |
| 105 | - A1-E Enrichment Data Consumer API |
| 106 | summary: Individual EI Job |
| 107 | operationId: getIndividualEiJobUsingGET |
| 108 | produces: |
| 109 | - application/json |
| 110 | parameters: |
| 111 | - name: eiJobId |
| 112 | in: path |
| 113 | description: eiJobId |
| 114 | required: true |
| 115 | type: string |
| 116 | - name: eiTypeId |
| 117 | in: path |
| 118 | description: eiTypeId |
| 119 | required: true |
| 120 | type: string |
| 121 | responses: |
| 122 | '200': |
| 123 | description: EI Job |
| 124 | schema: |
| 125 | $ref: '#/definitions/ei_job_info' |
| 126 | '401': |
| 127 | description: Unauthorized |
| 128 | '403': |
| 129 | description: Forbidden |
| 130 | '404': |
| 131 | description: Enrichment Information type or job is not found |
| 132 | schema: |
| 133 | $ref: '#/definitions/error_information' |
| 134 | deprecated: false |
| 135 | put: |
| 136 | tags: |
| 137 | - A1-E Enrichment Data Consumer API |
| 138 | summary: Individual EI Job |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 139 | operationId: putIndividualEiJobUsingPUT |
| 140 | consumes: |
| 141 | - application/json |
| 142 | produces: |
| 143 | - application/json |
| 144 | parameters: |
| 145 | - name: eiJobId |
| 146 | in: path |
| 147 | description: eiJobId |
| 148 | required: true |
| 149 | type: string |
| 150 | - in: body |
| 151 | name: eiJobInfo |
| 152 | description: eiJobInfo |
| 153 | required: true |
| 154 | schema: |
| 155 | $ref: '#/definitions/ei_job_info' |
| 156 | - name: eiTypeId |
| 157 | in: path |
| 158 | description: eiTypeId |
| 159 | required: true |
| 160 | type: string |
| 161 | responses: |
| 162 | '200': |
| 163 | description: Job updated |
| 164 | schema: |
| 165 | type: object |
| 166 | '201': |
| 167 | description: Job created |
| 168 | schema: |
| 169 | type: object |
| 170 | '401': |
| 171 | description: Unauthorized |
| 172 | '403': |
| 173 | description: Forbidden |
| 174 | '404': |
| 175 | description: Enrichment Information type is not found |
| 176 | schema: |
| 177 | $ref: '#/definitions/error_information' |
| 178 | deprecated: false |
| 179 | delete: |
| 180 | tags: |
| 181 | - A1-E Enrichment Data Consumer API |
| 182 | summary: Individual EI Job |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 183 | operationId: deleteIndividualEiJobUsingDELETE |
| 184 | produces: |
| 185 | - application/json |
| 186 | parameters: |
| 187 | - name: eiJobId |
| 188 | in: path |
| 189 | description: eiJobId |
| 190 | required: true |
| 191 | type: string |
| 192 | - name: eiTypeId |
| 193 | in: path |
| 194 | description: eiTypeId |
| 195 | required: true |
| 196 | type: string |
| 197 | responses: |
| 198 | '200': |
| 199 | description: Not used |
| 200 | schema: |
| 201 | type: object |
| 202 | '204': |
| 203 | description: Job deleted |
| 204 | schema: |
| 205 | type: object |
| 206 | '401': |
| 207 | description: Unauthorized |
| 208 | '403': |
| 209 | description: Forbidden |
| 210 | '404': |
| 211 | description: Enrichment Information type or job is not found |
| 212 | schema: |
| 213 | $ref: '#/definitions/error_information' |
| 214 | deprecated: false |
| 215 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status': |
| 216 | get: |
| 217 | tags: |
| 218 | - A1-E Enrichment Data Consumer API |
| 219 | summary: EI Job status |
| 220 | operationId: getEiJobStatusUsingGET |
| 221 | produces: |
| 222 | - application/json |
| 223 | parameters: |
| 224 | - name: eiJobId |
| 225 | in: path |
| 226 | description: eiJobId |
| 227 | required: true |
| 228 | type: string |
| 229 | - name: eiTypeId |
| 230 | in: path |
| 231 | description: eiTypeId |
| 232 | required: true |
| 233 | type: string |
| 234 | responses: |
| 235 | '200': |
| 236 | description: EI Job status |
| 237 | schema: |
| 238 | $ref: '#/definitions/ei_job_status' |
| 239 | '401': |
| 240 | description: Unauthorized |
| 241 | '403': |
| 242 | description: Forbidden |
| 243 | '404': |
| 244 | description: Enrichment Information type or job is not found |
| 245 | schema: |
| 246 | $ref: '#/definitions/error_information' |
| 247 | deprecated: false |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 248 | /ei-producer/v1/eiproducers: |
| 249 | get: |
| 250 | tags: |
| 251 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 252 | summary: EI producer identifiers |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 253 | operationId: getEiProducerIdentifiersUsingGET |
| 254 | produces: |
| 255 | - application/json |
| 256 | responses: |
| 257 | '200': |
| 258 | description: EI producer identifiers |
| 259 | schema: |
| 260 | type: array |
| 261 | items: |
| 262 | type: string |
| 263 | '401': |
| 264 | description: Unauthorized |
| 265 | '403': |
| 266 | description: Forbidden |
| 267 | '404': |
| 268 | description: Not Found |
| 269 | deprecated: false |
| 270 | '/ei-producer/v1/eiproducers/{eiProducerId}': |
| 271 | get: |
| 272 | tags: |
| 273 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 274 | summary: Individual EI producer |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 275 | operationId: getEiProducerUsingGET |
| 276 | produces: |
| 277 | - application/json |
| 278 | parameters: |
| 279 | - name: eiProducerId |
| 280 | in: path |
| 281 | description: eiProducerId |
| 282 | required: true |
| 283 | type: string |
| 284 | responses: |
| 285 | '200': |
| 286 | description: EI Jobs |
| 287 | schema: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 288 | $ref: '#/definitions/producer_registration_info' |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 289 | '401': |
| 290 | description: Unauthorized |
| 291 | '403': |
| 292 | description: Forbidden |
| 293 | '404': |
| 294 | description: Enrichment Information producer is not found |
| 295 | schema: |
| 296 | $ref: '#/definitions/error_information' |
| 297 | deprecated: false |
| 298 | put: |
| 299 | tags: |
| 300 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 301 | summary: Individual EI producer |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 302 | operationId: putEiProducerUsingPUT |
| 303 | consumes: |
| 304 | - application/json |
| 305 | produces: |
| 306 | - application/json |
| 307 | parameters: |
| 308 | - name: eiProducerId |
| 309 | in: path |
| 310 | description: eiProducerId |
| 311 | required: true |
| 312 | type: string |
| 313 | - in: body |
| 314 | name: registrationInfo |
| 315 | description: registrationInfo |
| 316 | required: true |
| 317 | schema: |
| 318 | $ref: '#/definitions/producer_registration_info' |
| 319 | responses: |
| 320 | '200': |
| 321 | description: Producer updated |
| 322 | schema: |
| 323 | type: object |
| 324 | '201': |
| 325 | description: Producer created |
| 326 | schema: |
| 327 | type: object |
| 328 | '401': |
| 329 | description: Unauthorized |
| 330 | '403': |
| 331 | description: Forbidden |
| 332 | '404': |
| 333 | description: Not Found |
| 334 | deprecated: false |
| 335 | delete: |
| 336 | tags: |
| 337 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 338 | summary: Individual EI producer |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 339 | operationId: deleteEiProducerUsingDELETE |
| 340 | produces: |
| 341 | - application/json |
| 342 | parameters: |
| 343 | - name: eiProducerId |
| 344 | in: path |
| 345 | description: eiProducerId |
| 346 | required: true |
| 347 | type: string |
| 348 | responses: |
| 349 | '200': |
| 350 | description: Not used |
| 351 | schema: |
| 352 | type: object |
| 353 | '204': |
| 354 | description: Producer deleted |
| 355 | schema: |
| 356 | type: object |
| 357 | '401': |
| 358 | description: Unauthorized |
| 359 | '403': |
| 360 | description: Forbidden |
| 361 | '404': |
| 362 | description: Producer is not found |
| 363 | schema: |
| 364 | $ref: '#/definitions/error_information' |
| 365 | deprecated: false |
| 366 | '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs': |
| 367 | get: |
| 368 | tags: |
| 369 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 370 | summary: EI job definitions |
| 371 | description: EI job definitions for one EI producer |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 372 | operationId: getEiProducerJobsUsingGET |
| 373 | produces: |
| 374 | - application/json |
| 375 | parameters: |
| 376 | - name: eiProducerId |
| 377 | in: path |
| 378 | description: eiProducerId |
| 379 | required: true |
| 380 | type: string |
| 381 | responses: |
| 382 | '200': |
| 383 | description: EI jobs |
| 384 | schema: |
| 385 | type: array |
| 386 | items: |
| 387 | $ref: '#/definitions/producer_ei_job_request' |
| 388 | '401': |
| 389 | description: Unauthorized |
| 390 | '403': |
| 391 | description: Forbidden |
| 392 | '404': |
| 393 | description: Enrichment Information producer is not found |
| 394 | schema: |
| 395 | $ref: '#/definitions/error_information' |
| 396 | deprecated: false |
| 397 | /ei-producer/v1/eitypes: |
| 398 | get: |
| 399 | tags: |
| 400 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 401 | summary: EI type identifiers |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 402 | operationId: getEiTypeIdentifiersUsingGET_1 |
| 403 | produces: |
| 404 | - application/json |
| 405 | responses: |
| 406 | '200': |
| 407 | description: EI type identifiers |
| 408 | schema: |
| 409 | type: array |
| 410 | items: |
| 411 | type: string |
| 412 | '401': |
| 413 | description: Unauthorized |
| 414 | '403': |
| 415 | description: Forbidden |
| 416 | '404': |
| 417 | description: Not Found |
| 418 | deprecated: false |
| 419 | '/ei-producer/v1/eitypes/{eiTypeId}': |
| 420 | get: |
| 421 | tags: |
| 422 | - Enrichment Data Producer API |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 423 | summary: Individual EI Type |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 424 | operationId: getEiTypeUsingGET_1 |
| 425 | produces: |
| 426 | - application/json |
| 427 | parameters: |
| 428 | - name: eiTypeId |
| 429 | in: path |
| 430 | description: eiTypeId |
| 431 | required: true |
| 432 | type: string |
| 433 | responses: |
| 434 | '200': |
| 435 | description: EI type |
| 436 | schema: |
| 437 | $ref: '#/definitions/producer_ei_type_info' |
| 438 | '401': |
| 439 | description: Unauthorized |
| 440 | '403': |
| 441 | description: Forbidden |
| 442 | '404': |
| 443 | description: Enrichment Information type is not found |
| 444 | schema: |
| 445 | $ref: '#/definitions/error_information' |
| 446 | deprecated: false |
| 447 | /producer_simulator/job_created: |
| 448 | post: |
| 449 | tags: |
| 450 | - Producer Simulator |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 451 | summary: Callback for EI job creation |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 452 | operationId: jobCreatedCallbackUsingPOST |
| 453 | consumes: |
| 454 | - application/json |
| 455 | produces: |
| 456 | - application/json |
| 457 | parameters: |
| 458 | - in: body |
| 459 | name: request |
| 460 | description: request |
| 461 | required: true |
| 462 | schema: |
| 463 | $ref: '#/definitions/producer_ei_job_request' |
| 464 | responses: |
| 465 | '200': |
| 466 | description: OK |
| 467 | schema: |
| 468 | type: object |
| 469 | '201': |
| 470 | description: Created |
| 471 | '401': |
| 472 | description: Unauthorized |
| 473 | '403': |
| 474 | description: Forbidden |
| 475 | '404': |
| 476 | description: Not Found |
| 477 | deprecated: false |
| 478 | /producer_simulator/job_deleted: |
| 479 | post: |
| 480 | tags: |
| 481 | - Producer Simulator |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 482 | summary: Callback for EI job deletion |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 483 | operationId: jobDeletedCallbackUsingPOST |
| 484 | consumes: |
| 485 | - application/json |
| 486 | produces: |
| 487 | - application/json |
| 488 | parameters: |
| 489 | - in: body |
| 490 | name: request |
| 491 | description: request |
| 492 | required: true |
| 493 | schema: |
| 494 | $ref: '#/definitions/producer_ei_job_request' |
| 495 | responses: |
| 496 | '200': |
| 497 | description: OK |
| 498 | schema: |
| 499 | type: object |
| 500 | '201': |
| 501 | description: Created |
| 502 | '401': |
| 503 | description: Unauthorized |
| 504 | '403': |
| 505 | description: Forbidden |
| 506 | '404': |
| 507 | description: Not Found |
| 508 | deprecated: false |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 509 | definitions: |
| 510 | ei_job_info: |
| 511 | type: object |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 512 | required: |
| 513 | - job_data |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 514 | - job_owner |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 515 | properties: |
| 516 | job_data: |
| 517 | type: object |
| 518 | description: EI Type specific job data |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 519 | job_owner: |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 520 | type: string |
| 521 | description: Identity of the owner of the job |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 522 | title: ei_job_info |
| 523 | description: Information for a Enrichment Information Job |
| 524 | ei_job_status: |
| 525 | type: object |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 526 | required: |
| 527 | - operational_state |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 528 | properties: |
| 529 | operational_state: |
| 530 | type: string |
| 531 | description: |- |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 532 | Operational state, values: |
| 533 | ENABLED: TBD |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 534 | DISABLED: TBD. |
| 535 | enum: |
| 536 | - ENABLED |
| 537 | - DISABLED |
| 538 | title: ei_job_status |
| 539 | description: Status for an EI Job |
| 540 | ei_type_info: |
| 541 | type: object |
| 542 | properties: |
| 543 | job_data_schema: |
| 544 | type: object |
| 545 | description: Json schema for the job data |
| 546 | title: ei_type_info |
| 547 | description: Information for an EI type |
| 548 | error_information: |
| 549 | type: object |
| 550 | properties: |
| 551 | detail: |
| 552 | type: string |
| 553 | example: EI job type not found |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 554 | description: A human-readable explanation specific to this occurrence of the problem. |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 555 | status: |
| 556 | type: integer |
| 557 | format: int32 |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 558 | example: 404 |
| 559 | description: The HTTP status code generated by the origin server for this occurrence of the problem. |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 560 | title: error_information |
| 561 | description: 'Problem as defined in https://tools.ietf.org/html/rfc7807' |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 562 | producer_ei_job_request: |
| 563 | type: object |
| 564 | required: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 565 | - ei_job_identity |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 566 | properties: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 567 | ei_job_data: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 568 | type: object |
| 569 | description: Json for the job data |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 570 | ei_job_identity: |
| 571 | type: string |
| 572 | description: Idenitity of the EI job |
| 573 | ei_type_identity: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 574 | type: string |
| 575 | description: Type idenitity for the job |
| 576 | title: producer_ei_job_request |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 577 | description: The body of the EI producer callbacks for EI job creation and deletion |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 578 | producer_ei_type_info: |
| 579 | type: object |
| 580 | properties: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 581 | ei_job_data_schema: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 582 | type: object |
| 583 | description: Json schema for the job data |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 584 | ei_producer_ids: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 585 | type: array |
| 586 | description: Registered producers |
| 587 | items: |
| 588 | type: string |
| 589 | title: producer_ei_type_info |
| 590 | description: Information for an EI type |
| 591 | producer_ei_type_registration_info: |
| 592 | type: object |
| 593 | required: |
| 594 | - ei_type_identity |
| 595 | properties: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 596 | ei_job_data_schema: |
| 597 | type: object |
| 598 | description: Json schema for the job data |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 599 | ei_type_identity: |
| 600 | type: string |
| 601 | description: EI type identity |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 602 | title: producer_ei_type_registration_info |
| 603 | description: Information for an EI type |
| 604 | producer_registration_info: |
| 605 | type: object |
| 606 | required: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 607 | - ei_job_creation_callback_url |
| 608 | - ei_job_deletion_callback_url |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 609 | - supported_ei_types |
| 610 | properties: |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 611 | ei_job_creation_callback_url: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 612 | type: string |
| 613 | description: callback for job creation |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 614 | ei_job_deletion_callback_url: |
PatrikBuhr | ebf3211 | 2020-09-16 13:17:29 +0200 | [diff] [blame] | 615 | type: string |
| 616 | description: callback for job deletion |
| 617 | supported_ei_types: |
| 618 | type: array |
| 619 | description: Supported EI types |
| 620 | items: |
| 621 | $ref: '#/definitions/producer_ei_type_registration_info' |
| 622 | title: producer_registration_info |
PatrikBuhr | 57b7c52 | 2020-09-18 15:13:03 +0200 | [diff] [blame] | 623 | description: Information for an EI producer |
PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 624 | |