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": ["Data Producer Job Control (example producer)"],
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": ["A1-EI (enrichment information) 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": ["Data Producer Registry 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": ["Data Producer Registry 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": ["Data Producer Job Control (example producer)"]
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"}
186 "allowEmptyValue": false,
187 "name": "ei_type_id",
188 "description": "If given, only the producers for the EI Data type is returned.",
192 "tags": ["Data Producer Registry API"]
194 "/ei-producer/v1/eitypes/{eiTypeId}": {
196 "summary": "Individual EI type",
198 "produces": ["application/json"],
199 "operationId": "getEiTypeUsingGET_1",
202 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
203 "description": "EI type"
205 "401": {"description": "Unauthorized"},
206 "403": {"description": "Forbidden"},
208 "schema": {"$ref": "#/definitions/ProblemDetails"},
209 "description": "Enrichment Information type is not found"
215 "description": "eiTypeId",
219 "tags": ["Data Producer Registry API"]
222 "summary": "Individual EI type",
224 "produces": ["application/json"],
225 "operationId": "deleteEiTypeUsingDELETE",
227 "200": {"description": "Not used"},
228 "401": {"description": "Unauthorized"},
229 "204": {"description": "Producer deleted"},
230 "403": {"description": "Forbidden"},
232 "schema": {"$ref": "#/definitions/ProblemDetails"},
233 "description": "Enrichment Information type is not found"
236 "schema": {"$ref": "#/definitions/ProblemDetails"},
237 "description": "The Enrichment Information type has one or several active producers"
243 "description": "eiTypeId",
247 "tags": ["Data Producer Registry API"]
250 "summary": "Individual EI type",
252 "produces": ["application/json"],
253 "operationId": "putEiTypeUsingPUT",
256 "schema": {"type": "object"},
259 "201": {"description": "Created"},
260 "401": {"description": "Unauthorized"},
261 "403": {"description": "Forbidden"},
262 "404": {"description": "Not Found"}
268 "description": "eiTypeId",
273 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
275 "name": "registrationInfo",
276 "description": "registrationInfo",
280 "tags": ["Data Producer Registry API"],
281 "consumes": ["application/json"]
285 "summary": "Returns status and statistics of this service",
287 "produces": ["application/json"],
288 "operationId": "getStatusUsingGET",
291 "schema": {"$ref": "#/definitions/status_info"},
292 "description": "Service is living"
294 "401": {"description": "Unauthorized"},
295 "403": {"description": "Forbidden"},
296 "404": {"description": "Not Found"}
298 "tags": ["Service status"]
300 "/A1-EI/v1/eijobs/{eiJobId}": {
302 "summary": "Individual EI job",
304 "produces": ["application/json"],
305 "operationId": "getIndividualEiJobUsingGET",
308 "schema": {"$ref": "#/definitions/EiJobObject"},
309 "description": "EI job"
311 "401": {"description": "Unauthorized"},
312 "403": {"description": "Forbidden"},
314 "schema": {"$ref": "#/definitions/ProblemDetails"},
315 "description": "Enrichment Information job is not found"
321 "description": "eiJobId",
325 "tags": ["A1-EI (enrichment information)"]
328 "summary": "Individual EI job",
330 "produces": ["application/json"],
331 "operationId": "deleteIndividualEiJobUsingDELETE",
333 "200": {"description": "Not used"},
334 "401": {"description": "Unauthorized"},
335 "204": {"description": "Job deleted"},
336 "403": {"description": "Forbidden"},
338 "schema": {"$ref": "#/definitions/ProblemDetails"},
339 "description": "Enrichment Information job is not found"
345 "description": "eiJobId",
349 "tags": ["A1-EI (enrichment information)"]
352 "summary": "Individual EI job",
354 "produces": ["application/json"],
355 "operationId": "putIndividualEiJobUsingPUT",
357 "200": {"description": "Job updated"},
358 "201": {"description": "Job created"},
359 "401": {"description": "Unauthorized"},
360 "403": {"description": "Forbidden"},
362 "schema": {"$ref": "#/definitions/ProblemDetails"},
363 "description": "Enrichment Information type is not found"
370 "description": "eiJobId",
375 "schema": {"$ref": "#/definitions/EiJobObject"},
377 "name": "eiJobObject",
378 "description": "eiJobObject",
382 "tags": ["A1-EI (enrichment information)"],
383 "consumes": ["application/json"]
386 "/ei-producer/v1/eiproducers/{eiProducerId}": {
388 "summary": "Individual EI producer",
390 "produces": ["application/json"],
391 "operationId": "getEiProducerUsingGET",
394 "schema": {"$ref": "#/definitions/producer_registration_info"},
395 "description": "EI jobs"
397 "401": {"description": "Unauthorized"},
398 "403": {"description": "Forbidden"},
400 "schema": {"$ref": "#/definitions/ProblemDetails"},
401 "description": "Enrichment Information producer is not found"
406 "name": "eiProducerId",
407 "description": "eiProducerId",
411 "tags": ["Data Producer Registry API"]
414 "summary": "Individual EI producer",
416 "produces": ["application/json"],
417 "operationId": "deleteEiProducerUsingDELETE",
419 "200": {"description": "Not used"},
420 "401": {"description": "Unauthorized"},
421 "204": {"description": "Producer deleted"},
422 "403": {"description": "Forbidden"},
424 "schema": {"$ref": "#/definitions/ProblemDetails"},
425 "description": "Producer is not found"
430 "name": "eiProducerId",
431 "description": "eiProducerId",
435 "tags": ["Data Producer Registry API"]
438 "summary": "Individual EI producer",
440 "produces": ["application/json"],
441 "operationId": "putEiProducerUsingPUT",
443 "200": {"description": "Producer updated"},
444 "201": {"description": "Producer created"},
445 "401": {"description": "Unauthorized"},
446 "403": {"description": "Forbidden"},
447 "404": {"description": "Not Found"}
452 "name": "eiProducerId",
453 "description": "eiProducerId",
458 "schema": {"$ref": "#/definitions/producer_registration_info"},
460 "name": "registrationInfo",
461 "description": "registrationInfo",
465 "tags": ["Data Producer Registry API"],
466 "consumes": ["application/json"]
469 "/producer_simulator/health_check": {"get": {
470 "summary": "Producer supervision",
472 "produces": ["application/json"],
473 "operationId": "producerSupervisionUsingGET",
476 "schema": {"type": "string"},
479 "401": {"description": "Unauthorized"},
480 "403": {"description": "Forbidden"},
481 "404": {"description": "Not Found"}
483 "tags": ["Data Producer Job Control (example producer)"]
485 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
486 "summary": "EI job definitions",
488 "produces": ["application/json"],
489 "description": "EI job definitions for one EI producer",
490 "operationId": "getEiProducerJobsUsingGET",
495 "items": {"$ref": "#/definitions/producer_ei_job_request"}
497 "description": "EI jobs"
499 "401": {"description": "Unauthorized"},
500 "403": {"description": "Forbidden"},
502 "schema": {"$ref": "#/definitions/ProblemDetails"},
503 "description": "Enrichment Information producer is not found"
508 "name": "eiProducerId",
509 "description": "eiProducerId",
513 "tags": ["Data Producer Registry API"]
515 "/A1-EI/v1/eijobs": {"get": {
516 "summary": "EI job identifiers",
518 "produces": ["application/json"],
519 "description": "query for EI job identifiers",
520 "operationId": "getEiJobIdsUsingGET",
525 "items": {"type": "string"}
527 "description": "EI job identifiers"
529 "401": {"description": "Unauthorized"},
530 "403": {"description": "Forbidden"},
532 "schema": {"$ref": "#/definitions/ProblemDetails"},
533 "description": "Enrichment Information type is not found"
539 "allowEmptyValue": false,
541 "description": "selects EI jobs of matching EI type",
547 "allowEmptyValue": false,
549 "description": "selects EI jobs for one EI job owner",
554 "tags": ["A1-EI (enrichment information)"]
556 "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
557 "summary": "EI job status",
559 "produces": ["application/json"],
560 "operationId": "getEiJobStatusUsingGET",
563 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
564 "description": "EI job status"
566 "401": {"description": "Unauthorized"},
567 "403": {"description": "Forbidden"},
569 "schema": {"$ref": "#/definitions/ProblemDetails"},
570 "description": "Enrichment Information job is not found"
576 "description": "eiJobId",
580 "tags": ["A1-EI (enrichment information)"]
584 "producer_ei_job_request": {
585 "description": "The body of the EI producer callbacks for EI job creation and deletion",
587 "title": "producer_ei_job_request",
588 "required": ["ei_job_identity"],
591 "description": "The owner of the job",
595 "description": "Idenitity of the EI job",
599 "description": "The time when the job was last updated or created (ISO-8601)",
603 "description": "Json for the job data",
607 "description": "URI for the target of the EI",
610 "ei_type_identity": {
611 "description": "Type idenitity for the job",
617 "description": "Information for an EI type",
619 "title": "EiTypeObject"
623 "title": "status_info",
627 "description": "Number of EI producers",
632 "description": "Number of EI jobs",
637 "description": "Number of EI types",
641 "description": "status text",
646 "Mono«ResponseEntity«object»»": {
648 "title": "Mono«ResponseEntity«object»»"
650 "producer_ei_type_info": {
651 "description": "Information for an EI type",
653 "title": "producer_ei_type_info",
654 "properties": {"ei_job_data_schema": {
655 "description": "Json schema for the job data",
659 "producer_registration_info": {
660 "description": "Information for an EI producer",
662 "title": "producer_registration_info",
664 "ei_job_callback_url",
665 "ei_producer_supervision_callback_url",
669 "supported_ei_types": {
670 "description": "Supported EI type IDs",
672 "items": {"type": "string"}
674 "ei_producer_supervision_callback_url": {
675 "description": "callback for producer supervision",
678 "ei_job_callback_url": {
679 "description": "callback for EI job",
685 "description": "Status for an EI Producer",
687 "title": "producer_status",
688 "required": ["operational_state"],
689 "properties": {"operational_state": {
690 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
699 "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
701 "title": "ProblemDetails",
704 "description": "A human-readable explanation specific to this occurrence of the problem.",
706 "example": "EI job type not found"
710 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
717 "description": "Void/empty",
721 "EiJobStatusObject": {
722 "description": "Status for an EI job",
724 "title": "EiJobStatusObject",
725 "required": ["eiJobStatus"],
726 "properties": {"eiJobStatus": {
727 "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",
736 "description": "Information for an Enrichment Information Job",
738 "title": "EiJobObject",
747 "description": "EI type Idenitifier of the EI job",
751 "description": "The target URI of the EI data",
755 "description": "Identity of the owner of the job",
758 "jobStatusNotificationUri": {
759 "description": "The target of EI job status notifications",
763 "description": "EI type specific job data",
771 "description": "This page lists all the rest apis for the service.",
772 "title": "Enrichment Data service",
777 "name": "A1-EI (enrichment information)",
778 "description": "Consumer Controller"
781 "name": "A1-EI (enrichment information) callbacks",
782 "description": "Consumer Simulator Controller"
785 "name": "Data Producer Job Control (example producer)",
786 "description": "Producer Simulator Controller"
789 "name": "Data Producer Registry API",
790 "description": "Producer Controller"
793 "name": "Service status",
794 "description": "Status Controller"