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

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