enrichment-coordinator-service/api/ecs-api.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: Data management and exposure
   4   description: <h1>API documentation</h1><h2>General</h2><p>  The service is mainly
   5     a broker between data producers and data consumers. A data producer has the ability
   6     to produce one or several types of data (EI type). One type of data can be produced
   7     by zero to many producers. <br /><br />A data consumer can have several active
   8     data subscriptions (EI job). One EI job consists of the type of data to produce
   9     and additional parameters for filtering of the data. These parameters are different
  10     for different data types.</p><h2>APIs provided by the service</h2><h4>A1-EI</h4><p>  This
  11     API is between Near-RT RIC and the Non-RT RIC.  The Near-RT RIC is a data consumer,
  12     which creates Enrichment Information Jobs to subscribe for data.</p><h4>Data producer
  13     API</h4><p>  This API is provided by the Non-RT RIC platform and is intended to
  14     be part of the O-RAN R1 interface.  The API is for use by different kinds of data
  15     producers and provides support for:<ul><li>Registry of supported information types
  16     and which parameters needed to setup a subscription.</li><li>Registry of existing
  17     data producers.</li><li>Callback API provided by producers to setup subscriptions.</li></ul></p><h4>Data
  18     consumer API</h4><p>  This API is provided by the Non-RT RIC platform and is intended
  19     to be part of the O-RAN R1 interface.  The API is for use by different kinds of
  20     data consumers and provides support for:<ul><li>Querying of available types of
  21     data to consume.</li><li>Management of data subscription jobs</li></ul></p><h4>EI
  22     Service status</h4><p>  This API provides a means to monitor the service.</p>
  23   license:
  24     name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
  25     url: http://www.apache.org/licenses/LICENSE-2.0
  26   version: "1.0"
  27 servers:
  28 - url: /
  29 tags:
  30 - name: A1-EI (registration)
  31   description: Data consumer EI job registration
  32 - name: A1-EI (callbacks)
  33   description: Data consumer EI job status callbacks
  34 - name: Data producer (callbacks)
  35   description: API implemented by data producers
  36 - name: Data producer (registration)
  37   description: API for data producers
  38 - name: Service status
  39   description: API for monitoring of the service
  40 - name: Data consumer
  41   description: API for data consumers
  42 paths:
  43   /producer_simulator/ei_job:
  44     post:
  45       tags:
  46       - Data producer (callbacks)
  47       summary: Callback for EI job creation/modification
  48       description: The call is invoked to activate or to modify a data subscription.
  49         The endpoint is provided by the EI producer.
  50       operationId: jobCreatedCallback
  51       requestBody:
  52         content:
  53           application/json:
  54             schema:
  55               $ref: '#/components/schemas/producer_ei_job_request'
  56         required: true
  57       responses:
  58         200:
  59           description: OK
  60           content:
  61             application/json:
  62               schema:
  63                 $ref: '#/components/schemas/Void'
  64   /A1-EI/v1/eitypes/{eiTypeId}:
  65     get:
  66       tags:
  67       - A1-EI (registration)
  68       summary: Individual EI type
  69       operationId: getEiType_1
  70       parameters:
  71       - name: eiTypeId
  72         in: path
  73         required: true
  74         style: simple
  75         explode: false
  76         schema:
  77           type: string
  78       responses:
  79         200:
  80           description: EI type
  81           content:
  82             application/json:
  83               schema:
  84                 $ref: '#/components/schemas/EiTypeObject'
  85         404:
  86           description: Enrichment Information type is not found
  87           content:
  88             application/json:
  89               schema:
  90                 $ref: '#/components/schemas/ProblemDetails'
  91   /ei-producer/v1/eitypes:
  92     get:
  93       tags:
  94       - Data producer (registration)
  95       summary: EI type identifiers
  96       operationId: getEiTypeIdentifiers
  97       responses:
  98         200:
  99           description: EI type identifiers
 100           content:
 101             application/json:
 102               schema:
 103                 type: array
 104                 items:
 105                   type: string
 106   /A1-EI/v1/eitypes:
 107     get:
 108       tags:
 109       - A1-EI (registration)
 110       summary: EI type identifiers
 111       operationId: getEiTypeIdentifiers_1
 112       responses:
 113         200:
 114           description: EI type identifiers
 115           content:
 116             application/json:
 117               schema:
 118                 type: array
 119                 items:
 120                   type: string
 121   /data-consumer/v1/info-types:
 122     get:
 123       tags:
 124       - Data consumer
 125       summary: Information type identifiers
 126       operationId: getinfoTypeIdentifiers
 127       responses:
 128         200:
 129           description: Information type identifiers
 130           content:
 131             application/json:
 132               schema:
 133                 type: array
 134                 items:
 135                   type: string
 136   /ei-producer/v1/eiproducers/{eiProducerId}/status:
 137     get:
 138       tags:
 139       - Data producer (registration)
 140       summary: EI producer status
 141       operationId: getEiProducerStatus
 142       parameters:
 143       - name: eiProducerId
 144         in: path
 145         required: true
 146         style: simple
 147         explode: false
 148         schema:
 149           type: string
 150       responses:
 151         200:
 152           description: EI producer status
 153           content:
 154             application/json:
 155               schema:
 156                 $ref: '#/components/schemas/producer_status'
 157         404:
 158           description: Enrichment Information producer is not found
 159           content:
 160             application/json:
 161               schema:
 162                 $ref: '#/components/schemas/ProblemDetails'
 163   /producer_simulator/ei_job/{eiJobId}:
 164     delete:
 165       tags:
 166       - Data producer (callbacks)
 167       summary: Callback for EI job deletion
 168       description: The call is invoked to terminate a data subscription. The endpoint
 169         is provided by the EI producer.
 170       operationId: jobDeletedCallback
 171       parameters:
 172       - name: eiJobId
 173         in: path
 174         required: true
 175         style: simple
 176         explode: false
 177         schema:
 178           type: string
 179       responses:
 180         200:
 181           description: OK
 182           content:
 183             application/json:
 184               schema:
 185                 $ref: '#/components/schemas/Void'
 186   /ei-producer/v1/eitypes/{eiTypeId}:
 187     get:
 188       tags:
 189       - Data producer (registration)
 190       summary: Individual EI type
 191       operationId: getEiType
 192       parameters:
 193       - name: eiTypeId
 194         in: path
 195         required: true
 196         style: simple
 197         explode: false
 198         schema:
 199           type: string
 200       responses:
 201         200:
 202           description: EI type
 203           content:
 204             application/json:
 205               schema:
 206                 $ref: '#/components/schemas/producer_ei_type_info'
 207         404:
 208           description: Enrichment Information type is not found
 209           content:
 210             application/json:
 211               schema:
 212                 $ref: '#/components/schemas/ProblemDetails'
 213     put:
 214       tags:
 215       - Data producer (registration)
 216       summary: Individual EI type
 217       operationId: putEiType
 218       parameters:
 219       - name: eiTypeId
 220         in: path
 221         required: true
 222         style: simple
 223         explode: false
 224         schema:
 225           type: string
 226       requestBody:
 227         content:
 228           application/json:
 229             schema:
 230               $ref: '#/components/schemas/producer_ei_type_info'
 231         required: true
 232       responses:
 233         200:
 234           description: Type updated
 235           content:
 236             application/json:
 237               schema:
 238                 $ref: '#/components/schemas/Void'
 239         201:
 240           description: Type created
 241           content:
 242             application/json:
 243               schema:
 244                 $ref: '#/components/schemas/Void'
 245         400:
 246           description: Bad request
 247           content:
 248             application/json:
 249               schema:
 250                 $ref: '#/components/schemas/ProblemDetails'
 251     delete:
 252       tags:
 253       - Data producer (registration)
 254       summary: Individual EI type
 255       operationId: deleteEiType
 256       parameters:
 257       - name: eiTypeId
 258         in: path
 259         required: true
 260         style: simple
 261         explode: false
 262         schema:
 263           type: string
 264       responses:
 265         200:
 266           description: Not used
 267           content:
 268             application/json:
 269               schema:
 270                 $ref: '#/components/schemas/Void'
 271         204:
 272           description: Producer deleted
 273           content:
 274             application/json:
 275               schema:
 276                 $ref: '#/components/schemas/Void'
 277         404:
 278           description: Enrichment Information type is not found
 279           content:
 280             application/json:
 281               schema:
 282                 $ref: '#/components/schemas/ProblemDetails'
 283         406:
 284           description: The Enrichment Information type has one or several active producers
 285           content:
 286             application/json:
 287               schema:
 288                 $ref: '#/components/schemas/ProblemDetails'
 289   /status:
 290     get:
 291       tags:
 292       - Service status
 293       summary: Returns status and statistics of this service
 294       operationId: getStatus
 295       responses:
 296         200:
 297           description: Service is living
 298           content:
 299             application/json:
 300               schema:
 301                 $ref: '#/components/schemas/status_info'
 302   /ei-producer/v1/eiproducers:
 303     get:
 304       tags:
 305       - Data producer (registration)
 306       summary: EI producer identifiers
 307       operationId: getEiProducerIdentifiers
 308       parameters:
 309       - name: ei_type_id
 310         in: query
 311         description: If given, only the producers for the EI Data type is returned.
 312         required: false
 313         style: form
 314         explode: true
 315         schema:
 316           type: string
 317       responses:
 318         200:
 319           description: EI producer identifiers
 320           content:
 321             application/json:
 322               schema:
 323                 type: array
 324                 items:
 325                   type: string
 326   /A1-EI/v1/eijobs/{eiJobId}:
 327     get:
 328       tags:
 329       - A1-EI (registration)
 330       summary: Individual EI job
 331       operationId: getIndividualEiJob_1
 332       parameters:
 333       - name: eiJobId
 334         in: path
 335         required: true
 336         style: simple
 337         explode: false
 338         schema:
 339           type: string
 340       responses:
 341         200:
 342           description: EI job
 343           content:
 344             application/json:
 345               schema:
 346                 $ref: '#/components/schemas/EiJobObject'
 347         404:
 348           description: Enrichment Information job is not found
 349           content:
 350             application/json:
 351               schema:
 352                 $ref: '#/components/schemas/ProblemDetails'
 353     put:
 354       tags:
 355       - A1-EI (registration)
 356       summary: Individual EI job
 357       operationId: putIndividualEiJob
 358       parameters:
 359       - name: eiJobId
 360         in: path
 361         required: true
 362         style: simple
 363         explode: false
 364         schema:
 365           type: string
 366       requestBody:
 367         content:
 368           application/json:
 369             schema:
 370               $ref: '#/components/schemas/EiJobObject'
 371         required: true
 372       responses:
 373         200:
 374           description: Job updated
 375           content:
 376             application/json:
 377               schema:
 378                 $ref: '#/components/schemas/Void'
 379         201:
 380           description: Job created
 381           content:
 382             application/json:
 383               schema:
 384                 $ref: '#/components/schemas/Void'
 385         404:
 386           description: Enrichment Information type is not found
 387           content:
 388             application/json:
 389               schema:
 390                 $ref: '#/components/schemas/ProblemDetails'
 391     delete:
 392       tags:
 393       - A1-EI (registration)
 394       summary: Individual EI job
 395       operationId: deleteIndividualEiJob_1
 396       parameters:
 397       - name: eiJobId
 398         in: path
 399         required: true
 400         style: simple
 401         explode: false
 402         schema:
 403           type: string
 404       responses:
 405         200:
 406           description: Not used
 407           content:
 408             application/json:
 409               schema:
 410                 $ref: '#/components/schemas/Void'
 411         204:
 412           description: Job deleted
 413           content:
 414             application/json:
 415               schema:
 416                 $ref: '#/components/schemas/Void'
 417         404:
 418           description: Enrichment Information job is not found
 419           content:
 420             application/json:
 421               schema:
 422                 $ref: '#/components/schemas/ProblemDetails'
 423   /ei-producer/v1/eiproducers/{eiProducerId}:
 424     get:
 425       tags:
 426       - Data producer (registration)
 427       summary: Individual EI producer
 428       operationId: getEiProducer
 429       parameters:
 430       - name: eiProducerId
 431         in: path
 432         required: true
 433         style: simple
 434         explode: false
 435         schema:
 436           type: string
 437       responses:
 438         200:
 439           description: EI producer
 440           content:
 441             application/json:
 442               schema:
 443                 $ref: '#/components/schemas/producer_registration_info'
 444         404:
 445           description: Enrichment Information producer is not found
 446           content:
 447             application/json:
 448               schema:
 449                 $ref: '#/components/schemas/ProblemDetails'
 450     put:
 451       tags:
 452       - Data producer (registration)
 453       summary: Individual EI producer
 454       operationId: putEiProducer
 455       parameters:
 456       - name: eiProducerId
 457         in: path
 458         required: true
 459         style: simple
 460         explode: false
 461         schema:
 462           type: string
 463       requestBody:
 464         content:
 465           application/json:
 466             schema:
 467               $ref: '#/components/schemas/producer_registration_info'
 468         required: true
 469       responses:
 470         200:
 471           description: Producer updated
 472           content:
 473             application/json:
 474               schema:
 475                 $ref: '#/components/schemas/Void'
 476         201:
 477           description: Producer created
 478           content:
 479             application/json:
 480               schema:
 481                 $ref: '#/components/schemas/Void'
 482         404:
 483           description: Producer not found
 484           content:
 485             application/json:
 486               schema:
 487                 $ref: '#/components/schemas/ProblemDetails'
 488     delete:
 489       tags:
 490       - Data producer (registration)
 491       summary: Individual EI producer
 492       operationId: deleteEiProducer
 493       parameters:
 494       - name: eiProducerId
 495         in: path
 496         required: true
 497         style: simple
 498         explode: false
 499         schema:
 500           type: string
 501       responses:
 502         200:
 503           description: Not used
 504           content:
 505             application/json:
 506               schema:
 507                 $ref: '#/components/schemas/Void'
 508         204:
 509           description: Producer deleted
 510           content:
 511             application/json:
 512               schema:
 513                 $ref: '#/components/schemas/Void'
 514         404:
 515           description: Producer is not found
 516           content:
 517             application/json:
 518               schema:
 519                 $ref: '#/components/schemas/ProblemDetails'
 520   /producer_simulator/health_check:
 521     get:
 522       tags:
 523       - Data producer (callbacks)
 524       summary: Producer supervision
 525       description: The endpoint is provided by the EI producer and is used for supervision
 526         of the producer.
 527       operationId: producerSupervision
 528       responses:
 529         200:
 530           description: The producer is OK
 531           content:
 532             application/json:
 533               schema:
 534                 type: string
 535   /data-consumer/v1/info-jobs:
 536     get:
 537       tags:
 538       - Data consumer
 539       summary: EI job identifiers
 540       description: query for information job identifiers
 541       operationId: getJobIds
 542       parameters:
 543       - name: infoTypeId
 544         in: query
 545         description: selects subscription jobs of matching information type
 546         required: false
 547         style: form
 548         explode: true
 549         schema:
 550           type: string
 551       - name: owner
 552         in: query
 553         description: selects subscription jobs for one job owner
 554         required: false
 555         style: form
 556         explode: true
 557         schema:
 558           type: string
 559       responses:
 560         200:
 561           description: Information information job identifiers
 562           content:
 563             application/json:
 564               schema:
 565                 type: array
 566                 items:
 567                   type: string
 568         404:
 569           description: Information type is not found
 570           content:
 571             application/json:
 572               schema:
 573                 $ref: '#/components/schemas/ProblemDetails'
 574   /data-consumer/v1/info-jobs/{infoJobId}:
 575     get:
 576       tags:
 577       - Data consumer
 578       summary: Individual data subscription job
 579       operationId: getIndividualEiJob
 580       parameters:
 581       - name: infoJobId
 582         in: path
 583         required: true
 584         style: simple
 585         explode: false
 586         schema:
 587           type: string
 588       responses:
 589         200:
 590           description: Information subscription job
 591           content:
 592             application/json:
 593               schema:
 594                 $ref: '#/components/schemas/Job'
 595         404:
 596           description: Information subscription job is not found
 597           content:
 598             application/json:
 599               schema:
 600                 $ref: '#/components/schemas/ProblemDetails'
 601     put:
 602       tags:
 603       - Data consumer
 604       summary: Individual data subscription job
 605       operationId: putIndividualInfoJob
 606       parameters:
 607       - name: infoJobId
 608         in: path
 609         required: true
 610         style: simple
 611         explode: false
 612         schema:
 613           type: string
 614       requestBody:
 615         content:
 616           application/json:
 617             schema:
 618               $ref: '#/components/schemas/Job'
 619         required: true
 620       responses:
 621         200:
 622           description: Job updated
 623           content:
 624             application/json:
 625               schema:
 626                 $ref: '#/components/schemas/Void'
 627         201:
 628           description: Job created
 629           content:
 630             application/json:
 631               schema:
 632                 $ref: '#/components/schemas/Void'
 633         404:
 634           description: Enrichment Information type is not found
 635           content:
 636             application/json:
 637               schema:
 638                 $ref: '#/components/schemas/ProblemDetails'
 639     delete:
 640       tags:
 641       - Data consumer
 642       summary: Individual data subscription job
 643       operationId: deleteIndividualEiJob
 644       parameters:
 645       - name: infoJobId
 646         in: path
 647         required: true
 648         style: simple
 649         explode: false
 650         schema:
 651           type: string
 652       responses:
 653         200:
 654           description: Not used
 655           content:
 656             application/json:
 657               schema:
 658                 $ref: '#/components/schemas/Void'
 659         204:
 660           description: Job deleted
 661           content:
 662             application/json:
 663               schema:
 664                 $ref: '#/components/schemas/Void'
 665         404:
 666           description: Information subscription job is not found
 667           content:
 668             application/json:
 669               schema:
 670                 $ref: '#/components/schemas/ProblemDetails'
 671   /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
 672     get:
 673       tags:
 674       - Data producer (registration)
 675       summary: EI job definitions
 676       description: EI job definitions for one EI producer
 677       operationId: getEiProducerJobs
 678       parameters:
 679       - name: eiProducerId
 680         in: path
 681         required: true
 682         style: simple
 683         explode: false
 684         schema:
 685           type: string
 686       responses:
 687         200:
 688           description: EI producer
 689           content:
 690             application/json:
 691               schema:
 692                 type: array
 693                 items:
 694                   $ref: '#/components/schemas/producer_ei_job_request'
 695         404:
 696           description: Enrichment Information producer is not found
 697           content:
 698             application/json:
 699               schema:
 700                 $ref: '#/components/schemas/ProblemDetails'
 701   /data-consumer/v1/info-types/{infoTypeId}:
 702     get:
 703       tags:
 704       - Data consumer
 705       summary: Individual information type
 706       operationId: getInfoType
 707       parameters:
 708       - name: infoTypeId
 709         in: path
 710         required: true
 711         style: simple
 712         explode: false
 713         schema:
 714           type: string
 715       responses:
 716         200:
 717           description: Information type
 718           content:
 719             application/json:
 720               schema:
 721                 $ref: '#/components/schemas/InformationType'
 722         404:
 723           description: Information type is not found
 724           content:
 725             application/json:
 726               schema:
 727                 $ref: '#/components/schemas/ProblemDetails'
 728   /A1-EI/v1/eijobs:
 729     get:
 730       tags:
 731       - A1-EI (registration)
 732       summary: EI job identifiers
 733       description: query for EI job identifiers
 734       operationId: getEiJobIds
 735       parameters:
 736       - name: eiTypeId
 737         in: query
 738         description: selects EI jobs of matching EI type
 739         required: false
 740         style: form
 741         explode: true
 742         schema:
 743           type: string
 744       - name: owner
 745         in: query
 746         description: selects EI jobs for one EI job owner
 747         required: false
 748         style: form
 749         explode: true
 750         schema:
 751           type: string
 752       responses:
 753         200:
 754           description: EI job identifiers
 755           content:
 756             application/json:
 757               schema:
 758                 type: array
 759                 items:
 760                   type: string
 761         404:
 762           description: Enrichment Information type is not found
 763           content:
 764             application/json:
 765               schema:
 766                 $ref: '#/components/schemas/ProblemDetails'
 767   /A1-EI/v1/eijobs/{eiJobId}/status:
 768     get:
 769       tags:
 770       - A1-EI (registration)
 771       summary: EI job status
 772       operationId: getEiJobStatus_1
 773       parameters:
 774       - name: eiJobId
 775         in: path
 776         required: true
 777         style: simple
 778         explode: false
 779         schema:
 780           type: string
 781       responses:
 782         200:
 783           description: EI job status
 784           content:
 785             application/json:
 786               schema:
 787                 $ref: '#/components/schemas/EiJobStatusObject'
 788         404:
 789           description: Enrichment Information job is not found
 790           content:
 791             application/json:
 792               schema:
 793                 $ref: '#/components/schemas/ProblemDetails'
 794   /example_dataconsumer/eijobs/{eiJobId}/status:
 795     post:
 796       tags:
 797       - A1-EI (callbacks)
 798       summary: Callback for changed EI job status
 799       description: The primitive is implemented by the data consumer and is invoked
 800         when a EI job status has been changed.
 801       operationId: jobStatusCallback
 802       parameters:
 803       - name: eiJobId
 804         in: path
 805         required: true
 806         style: simple
 807         explode: false
 808         schema:
 809           type: string
 810       requestBody:
 811         content:
 812           application/json:
 813             schema:
 814               $ref: '#/components/schemas/EiJobStatusObject'
 815         required: true
 816       responses:
 817         200:
 818           description: OK
 819           content:
 820             application/json:
 821               schema:
 822                 $ref: '#/components/schemas/Void'
 823   /data-consumer/v1/info-jobs/{infoJobId}/status:
 824     get:
 825       tags:
 826       - Data consumer
 827       summary: Job status
 828       operationId: getEiJobStatus
 829       parameters:
 830       - name: infoJobId
 831         in: path
 832         required: true
 833         style: simple
 834         explode: false
 835         schema:
 836           type: string
 837       responses:
 838         200:
 839           description: Information subscription job status
 840           content:
 841             application/json:
 842               schema:
 843                 $ref: '#/components/schemas/JobStatus'
 844         404:
 845           description: Information subscription job is not found
 846           content:
 847             application/json:
 848               schema:
 849                 $ref: '#/components/schemas/ProblemDetails'
 850 components:
 851   schemas:
 852     producer_ei_job_request:
 853       required:
 854       - ei_job_identity
 855       type: object
 856       properties:
 857         owner:
 858           type: string
 859           description: The owner of the job
 860         ei_job_identity:
 861           type: string
 862           description: Idenitity of the EI job
 863         last_updated:
 864           type: string
 865           description: The time when the job was last updated or created (ISO-8601)
 866         ei_job_data:
 867           type: object
 868           description: Json for the job data
 869         target_uri:
 870           type: string
 871           description: URI for the target of the EI
 872         ei_type_identity:
 873           type: string
 874           description: Type idenitity for the job
 875       description: The body of the EI producer callbacks for EI job creation and deletion
 876     EiTypeObject:
 877       type: object
 878       description: Information for an EI type
 879     status_info:
 880       required:
 881       - no_of_jobs
 882       - no_of_producers
 883       - no_of_types
 884       - status
 885       type: object
 886       properties:
 887         no_of_producers:
 888           type: integer
 889           description: Number of EI producers
 890           format: int32
 891         no_of_types:
 892           type: integer
 893           description: Number of EI types
 894           format: int32
 895         no_of_jobs:
 896           type: integer
 897           description: Number of EI jobs
 898           format: int32
 899         status:
 900           type: string
 901           description: status text
 902     producer_ei_type_info:
 903       required:
 904       - ei_job_data_schema
 905       type: object
 906       properties:
 907         ei_job_data_schema:
 908           type: object
 909           description: Json schema for the job data
 910       description: Information for an EI type
 911     producer_registration_info:
 912       required:
 913       - ei_job_callback_url
 914       - ei_producer_supervision_callback_url
 915       - supported_ei_types
 916       type: object
 917       properties:
 918         supported_ei_types:
 919           type: array
 920           description: Supported EI type IDs
 921           items:
 922             type: string
 923             description: Supported EI type IDs
 924         ei_producer_supervision_callback_url:
 925           type: string
 926           description: callback for producer supervision
 927         ei_job_callback_url:
 928           type: string
 929           description: callback for EI job
 930       description: Information for an EI producer
 931     ProblemDetails:
 932       type: object
 933       properties:
 934         detail:
 935           type: string
 936           description: A human-readable explanation specific to this occurrence of
 937             the problem.
 938           example: EI job type not found
 939         status:
 940           type: integer
 941           description: The HTTP status code generated by the origin server for this
 942             occurrence of the problem.
 943           format: int32
 944           example: 404
 945       description: A problem detail to carry details in a HTTP response according
 946         to RFC 7807
 947     EiJobStatusObject:
 948       required:
 949       - eiJobStatus
 950       type: object
 951       properties:
 952         eiJobStatus:
 953           type: string
 954           description: Allowed values for EI job status
 955           enum:
 956           - ENABLED
 957           - DISABLED
 958       description: Status for an EI job
 959     EiJobObject:
 960       required:
 961       - eiTypeId
 962       - jobDefinition
 963       - jobOwner
 964       - jobResultUri
 965       type: object
 966       properties:
 967         eiTypeId:
 968           type: string
 969           description: EI type Idenitifier of the EI job
 970         jobResultUri:
 971           type: string
 972           description: The target URI of the EI data
 973         jobOwner:
 974           type: string
 975           description: Identity of the owner of the job
 976         statusNotificationUri:
 977           type: string
 978           description: The target of EI job status notifications
 979         jobDefinition:
 980           type: object
 981           description: EI type specific job data
 982       description: Information for an Enrichment Information Job
 983     JobStatus:
 984       required:
 985       - eiJobStatus
 986       type: object
 987       properties:
 988         eiJobStatus:
 989           type: string
 990           description: Allowed values for EI job status
 991           enum:
 992           - ENABLED
 993           - DISABLED
 994       description: Status for an EI job
 995     producer_status:
 996       required:
 997       - operational_state
 998       type: object
 999       properties:
1000         operational_state:
1001           type: string
1002           description: Represents the operational states
1003           enum:
1004           - ENABLED
1005           - DISABLED
1006       description: Status for an EI Producer
1007     Void:
1008       type: object
1009       description: 'Void/empty '
1010     Job:
1011       required:
1012       - infoTypeId
1013       - jobDefinition
1014       - jobOwner
1015       - jobResultUri
1016       type: object
1017       properties:
1018         jobResultUri:
1019           type: string
1020           description: The target URI of the subscribed information
1021         infoTypeId:
1022           type: string
1023           description: Information type Idenitifier of the subscription job
1024         jobOwner:
1025           type: string
1026           description: Identity of the owner of the job
1027         statusNotificationUri:
1028           type: string
1029           description: The target of Information subscription job status notifications
1030         jobDefinition:
1031           type: object
1032           description: Information type specific job data
1033       description: Information for an Enrichment Information Job
1034     InformationType:
1035       required:
1036       - consumer_job_data_schema
1037       type: object
1038       properties:
1039         consumer_job_data_schema:
1040           type: object
1041           description: Json schema for the job data
1042       description: Information for an Information type