4 "/producer_simulator/ei_job": {"post": {
5 "summary": "Callback for EI job creation",
7 "produces": ["application/json"],
8 "operationId": "jobCreatedCallbackUsingPOST",
10 "200": {"description": "OK"},
11 "201": {"description": "Created"},
12 "401": {"description": "Unauthorized"},
13 "403": {"description": "Forbidden"},
14 "404": {"description": "Not Found"}
17 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
20 "description": "request",
23 "tags": ["Producer Callbacks"],
24 "consumes": ["application/json"]
26 "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
27 "summary": "Individual EI type",
29 "produces": ["application/json"],
30 "operationId": "getEiTypeUsingGET",
33 "schema": {"$ref": "#/definitions/EiTypeObject"},
34 "description": "EI type"
36 "401": {"description": "Unauthorized"},
37 "403": {"description": "Forbidden"},
39 "schema": {"$ref": "#/definitions/ProblemDetails"},
40 "description": "Enrichment Information type is not found"
46 "description": "eiTypeId",
50 "tags": ["A1-EI (enrichment information)"]
52 "/consumer_simulator/eijobs/{eiJobId}/status": {"post": {
53 "summary": "Callback for EI job status",
55 "produces": ["application/json"],
56 "operationId": "jobStatusCallbackUsingPOST",
58 "200": {"description": "OK"},
59 "201": {"description": "Created"},
60 "401": {"description": "Unauthorized"},
61 "403": {"description": "Forbidden"},
62 "404": {"description": "Not Found"}
68 "description": "eiJobId",
73 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
76 "description": "status",
80 "tags": ["Consumer Callbacks"],
81 "consumes": ["application/json"]
83 "/ei-producer/v1/eitypes": {"get": {
84 "summary": "EI type identifiers",
86 "produces": ["application/json"],
87 "operationId": "getEiTypeIdentifiersUsingGET_1",
92 "items": {"type": "string"}
94 "description": "EI type identifiers"
96 "401": {"description": "Unauthorized"},
97 "403": {"description": "Forbidden"},
98 "404": {"description": "Not Found"}
100 "tags": ["Enrichment Data Producer API"]
102 "/A1-EI/v1/eitypes": {"get": {
103 "summary": "EI type identifiers",
105 "produces": ["application/json"],
106 "operationId": "getEiTypeIdentifiersUsingGET",
111 "items": {"type": "string"}
113 "description": "EI type identifiers"
115 "401": {"description": "Unauthorized"},
116 "403": {"description": "Forbidden"},
117 "404": {"description": "Not Found"}
119 "tags": ["A1-EI (enrichment information)"]
121 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
122 "summary": "EI producer status",
124 "produces": ["application/json"],
125 "operationId": "getEiProducerStatusUsingGET",
128 "schema": {"$ref": "#/definitions/producer_status"},
129 "description": "EI jobs"
131 "401": {"description": "Unauthorized"},
132 "403": {"description": "Forbidden"},
134 "schema": {"$ref": "#/definitions/ProblemDetails"},
135 "description": "Enrichment Information producer is not found"
140 "name": "eiProducerId",
141 "description": "eiProducerId",
145 "tags": ["Enrichment Data Producer API"]
147 "/producer_simulator/ei_job/{eiJobId}": {"delete": {
148 "summary": "Callback for EI job deletion",
150 "produces": ["application/json"],
151 "operationId": "jobDeletedCallbackUsingDELETE",
153 "200": {"description": "OK"},
154 "401": {"description": "Unauthorized"},
155 "204": {"description": "No Content"},
156 "403": {"description": "Forbidden"}
161 "description": "eiJobId",
165 "tags": ["Producer Callbacks"]
167 "/ei-producer/v1/eiproducers": {"get": {
168 "summary": "EI producer identifiers",
170 "produces": ["application/json"],
171 "operationId": "getEiProducerIdentifiersUsingGET",
176 "items": {"type": "string"}
178 "description": "EI producer identifiers"
180 "401": {"description": "Unauthorized"},
181 "403": {"description": "Forbidden"},
182 "404": {"description": "Not Found"}
184 "tags": ["Enrichment Data Producer API"]
186 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
187 "summary": "Individual EI type",
189 "produces": ["application/json"],
190 "operationId": "getEiTypeUsingGET_1",
193 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
194 "description": "EI type"
196 "401": {"description": "Unauthorized"},
197 "403": {"description": "Forbidden"},
199 "schema": {"$ref": "#/definitions/ProblemDetails"},
200 "description": "Enrichment Information type is not found"
206 "description": "eiTypeId",
210 "tags": ["Enrichment Data Producer API"]
213 "summary": "Returns status and statistics of this service",
215 "produces": ["application/json"],
216 "operationId": "getStatusUsingGET",
219 "schema": {"$ref": "#/definitions/status_info"},
220 "description": "Service is living"
222 "401": {"description": "Unauthorized"},
223 "403": {"description": "Forbidden"},
224 "404": {"description": "Not Found"}
226 "tags": ["Service status"]
228 "/A1-EI/v1/eijobs/{eiJobId}": {
230 "summary": "Individual EI job",
232 "produces": ["application/json"],
233 "operationId": "getIndividualEiJobUsingGET",
236 "schema": {"$ref": "#/definitions/EiJobObject"},
237 "description": "EI job"
239 "401": {"description": "Unauthorized"},
240 "403": {"description": "Forbidden"},
242 "schema": {"$ref": "#/definitions/ProblemDetails"},
243 "description": "Enrichment Information job is not found"
249 "description": "eiJobId",
253 "tags": ["A1-EI (enrichment information)"]
256 "summary": "Individual EI job",
258 "produces": ["application/json"],
259 "operationId": "deleteIndividualEiJobUsingDELETE",
261 "200": {"description": "Not used"},
262 "401": {"description": "Unauthorized"},
263 "204": {"description": "Job deleted"},
264 "403": {"description": "Forbidden"},
266 "schema": {"$ref": "#/definitions/ProblemDetails"},
267 "description": "Enrichment Information job is not found"
273 "description": "eiJobId",
277 "tags": ["A1-EI (enrichment information)"]
280 "summary": "Individual EI job",
282 "produces": ["application/json"],
283 "operationId": "putIndividualEiJobUsingPUT",
285 "200": {"description": "Job updated"},
286 "201": {"description": "Job created"},
287 "401": {"description": "Unauthorized"},
288 "403": {"description": "Forbidden"},
290 "schema": {"$ref": "#/definitions/ProblemDetails"},
291 "description": "Enrichment Information type is not found"
298 "description": "eiJobId",
303 "schema": {"$ref": "#/definitions/EiJobObject"},
305 "name": "eiJobObject",
306 "description": "eiJobObject",
310 "tags": ["A1-EI (enrichment information)"],
311 "consumes": ["application/json"]
314 "/ei-producer/v1/eiproducers/{eiProducerId}": {
316 "summary": "Individual EI producer",
318 "produces": ["application/json"],
319 "operationId": "getEiProducerUsingGET",
322 "schema": {"$ref": "#/definitions/producer_registration_info"},
323 "description": "EI jobs"
325 "401": {"description": "Unauthorized"},
326 "403": {"description": "Forbidden"},
328 "schema": {"$ref": "#/definitions/ProblemDetails"},
329 "description": "Enrichment Information producer is not found"
334 "name": "eiProducerId",
335 "description": "eiProducerId",
339 "tags": ["Enrichment Data Producer API"]
342 "summary": "Individual EI producer",
344 "produces": ["application/json"],
345 "operationId": "deleteEiProducerUsingDELETE",
347 "200": {"description": "Not used"},
348 "401": {"description": "Unauthorized"},
349 "204": {"description": "Producer deleted"},
350 "403": {"description": "Forbidden"},
352 "schema": {"$ref": "#/definitions/ProblemDetails"},
353 "description": "Producer is not found"
358 "name": "eiProducerId",
359 "description": "eiProducerId",
363 "tags": ["Enrichment Data Producer API"]
366 "summary": "Individual EI producer",
368 "produces": ["application/json"],
369 "operationId": "putEiProducerUsingPUT",
371 "200": {"description": "Producer updated"},
372 "201": {"description": "Producer created"},
373 "401": {"description": "Unauthorized"},
374 "403": {"description": "Forbidden"},
375 "404": {"description": "Not Found"}
380 "name": "eiProducerId",
381 "description": "eiProducerId",
386 "schema": {"$ref": "#/definitions/producer_registration_info"},
388 "name": "registrationInfo",
389 "description": "registrationInfo",
393 "tags": ["Enrichment Data Producer API"],
394 "consumes": ["application/json"]
397 "/producer_simulator/health_check": {"get": {
398 "summary": "Producer supervision",
400 "produces": ["application/json"],
401 "operationId": "producerSupervisionUsingGET",
404 "schema": {"type": "string"},
407 "401": {"description": "Unauthorized"},
408 "403": {"description": "Forbidden"},
409 "404": {"description": "Not Found"}
411 "tags": ["Producer Callbacks"]
413 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
414 "summary": "EI job definitions",
416 "produces": ["application/json"],
417 "description": "EI job definitions for one EI producer",
418 "operationId": "getEiProducerJobsUsingGET",
423 "items": {"$ref": "#/definitions/producer_ei_job_request"}
425 "description": "EI jobs"
427 "401": {"description": "Unauthorized"},
428 "403": {"description": "Forbidden"},
430 "schema": {"$ref": "#/definitions/ProblemDetails"},
431 "description": "Enrichment Information producer is not found"
436 "name": "eiProducerId",
437 "description": "eiProducerId",
441 "tags": ["Enrichment Data Producer API"]
443 "/A1-EI/v1/eijobs": {"get": {
444 "summary": "EI job identifiers",
446 "produces": ["application/json"],
447 "description": "query for EI job identifiers",
448 "operationId": "getEiJobIdsUsingGET",
453 "items": {"type": "string"}
455 "description": "EI job identifiers"
457 "401": {"description": "Unauthorized"},
458 "403": {"description": "Forbidden"},
460 "schema": {"$ref": "#/definitions/ProblemDetails"},
461 "description": "Enrichment Information type is not found"
467 "allowEmptyValue": false,
469 "description": "selects EI jobs of matching EI type",
475 "allowEmptyValue": false,
477 "description": "selects EI jobs for one EI job owner",
482 "tags": ["A1-EI (enrichment information)"]
484 "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
485 "summary": "EI job status",
487 "produces": ["application/json"],
488 "operationId": "getEiJobStatusUsingGET",
491 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
492 "description": "EI job status"
494 "401": {"description": "Unauthorized"},
495 "403": {"description": "Forbidden"},
497 "schema": {"$ref": "#/definitions/ProblemDetails"},
498 "description": "Enrichment Information job is not found"
504 "description": "eiJobId",
508 "tags": ["A1-EI (enrichment information)"]
511 "host": "localhost:34053",
513 "producer_ei_job_request": {
514 "description": "The body of the EI producer callbacks for EI job creation and deletion",
516 "title": "producer_ei_job_request",
517 "required": ["ei_job_identity"],
520 "description": "The owner of the job",
524 "description": "Idenitity of the EI job",
528 "description": "Json for the job data",
532 "description": "URI for the target of the EI",
535 "ei_type_identity": {
536 "description": "Type idenitity for the job",
542 "description": "Information for an EI type",
544 "title": "EiTypeObject"
546 "producer_ei_type_registration_info": {
547 "description": "Information for an EI type",
549 "title": "producer_ei_type_registration_info",
550 "required": ["ei_type_identity"],
552 "ei_type_identity": {
553 "description": "EI type identity",
556 "ei_job_data_schema": {
557 "description": "Json schema for the job data",
564 "title": "status_info",
568 "description": "Number of EI producers",
573 "description": "Number of EI jobs",
578 "description": "Number of EI types",
582 "description": "status text",
587 "Mono«ResponseEntity«object»»": {
589 "title": "Mono«ResponseEntity«object»»"
591 "producer_ei_type_info": {
592 "description": "Information for an EI type",
594 "title": "producer_ei_type_info",
597 "description": "Registered producers",
599 "items": {"type": "string"}
601 "ei_job_data_schema": {
602 "description": "Json schema for the job data",
607 "producer_registration_info": {
608 "description": "Information for an EI producer",
610 "title": "producer_registration_info",
612 "ei_job_callback_url",
613 "ei_producer_supervision_callback_url",
617 "supported_ei_types": {
618 "description": "Supported EI types",
620 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
622 "ei_producer_supervision_callback_url": {
623 "description": "callback for producer supervision",
626 "ei_job_callback_url": {
627 "description": "callback for EI job",
633 "description": "Status for an EI Producer",
635 "title": "producer_status",
636 "required": ["operational_state"],
637 "properties": {"operational_state": {
638 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
647 "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
649 "title": "ProblemDetails",
652 "description": "A human-readable explanation specific to this occurrence of the problem.",
654 "example": "EI job type not found"
658 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
665 "description": "Void/empty",
669 "EiJobStatusObject": {
670 "description": "Status for an EI job",
672 "title": "EiJobStatusObject",
673 "required": ["eiJobStatus"],
674 "properties": {"eiJobStatus": {
675 "description": "values:\nENABLED: the A1-EI producer is able to deliver EI result for the EI job\nDISABLED: the A1-EI producer is unable to deliver EI result for the EI job",
684 "description": "Information for an Enrichment Information Job",
686 "title": "EiJobObject",
695 "description": "EI type Idenitifier of the EI job",
699 "description": "The target URI of the EI data",
703 "description": "Identity of the owner of the job",
706 "jobStatusNotificationUri": {
707 "description": "The target of EI job status notifications",
711 "description": "EI type specific job data",
719 "description": "This page lists all the rest apis for the service.",
720 "title": "Enrichment Data service",
725 "name": "A1-EI (enrichment information)",
726 "description": "Consumer Controller"
729 "name": "Consumer Callbacks",
730 "description": "Consumer Simulator Controller"
733 "name": "Enrichment Data Producer API",
734 "description": "Producer Controller"
737 "name": "Producer Callbacks",
738 "description": "Producer Simulator Controller"
741 "name": "Service status",
742 "description": "Status Controller"