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 producer status"
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",
255 "200": {"description": "Type updated"},
256 "201": {"description": "Type created"},
258 "schema": {"$ref": "#/definitions/ProblemDetails"},
259 "description": "Bad request"
261 "401": {"description": "Unauthorized"},
262 "403": {"description": "Forbidden"},
263 "404": {"description": "Not Found"}
269 "description": "eiTypeId",
274 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
276 "name": "registrationInfo",
277 "description": "registrationInfo",
281 "tags": ["Data Producer Registry API"],
282 "consumes": ["application/json"]
286 "summary": "Returns status and statistics of this service",
288 "produces": ["application/json"],
289 "operationId": "getStatusUsingGET",
292 "schema": {"$ref": "#/definitions/status_info"},
293 "description": "Service is living"
295 "401": {"description": "Unauthorized"},
296 "403": {"description": "Forbidden"},
297 "404": {"description": "Not Found"}
299 "tags": ["Service status"]
301 "/A1-EI/v1/eijobs/{eiJobId}": {
303 "summary": "Individual EI job",
305 "produces": ["application/json"],
306 "operationId": "getIndividualEiJobUsingGET",
309 "schema": {"$ref": "#/definitions/EiJobObject"},
310 "description": "EI job"
312 "401": {"description": "Unauthorized"},
313 "403": {"description": "Forbidden"},
315 "schema": {"$ref": "#/definitions/ProblemDetails"},
316 "description": "Enrichment Information job is not found"
322 "description": "eiJobId",
326 "tags": ["A1-EI (enrichment information)"]
329 "summary": "Individual EI job",
331 "produces": ["application/json"],
332 "operationId": "deleteIndividualEiJobUsingDELETE",
334 "200": {"description": "Not used"},
335 "401": {"description": "Unauthorized"},
336 "204": {"description": "Job deleted"},
337 "403": {"description": "Forbidden"},
339 "schema": {"$ref": "#/definitions/ProblemDetails"},
340 "description": "Enrichment Information job is not found"
346 "description": "eiJobId",
350 "tags": ["A1-EI (enrichment information)"]
353 "summary": "Individual EI job",
355 "produces": ["application/json"],
356 "operationId": "putIndividualEiJobUsingPUT",
358 "200": {"description": "Job updated"},
359 "201": {"description": "Job created"},
360 "401": {"description": "Unauthorized"},
361 "403": {"description": "Forbidden"},
363 "schema": {"$ref": "#/definitions/ProblemDetails"},
364 "description": "Enrichment Information type is not found"
371 "description": "eiJobId",
376 "schema": {"$ref": "#/definitions/EiJobObject"},
378 "name": "eiJobObject",
379 "description": "eiJobObject",
383 "tags": ["A1-EI (enrichment information)"],
384 "consumes": ["application/json"]
387 "/ei-producer/v1/eiproducers/{eiProducerId}": {
389 "summary": "Individual EI producer",
391 "produces": ["application/json"],
392 "operationId": "getEiProducerUsingGET",
395 "schema": {"$ref": "#/definitions/producer_registration_info"},
396 "description": "EI producer"
398 "401": {"description": "Unauthorized"},
399 "403": {"description": "Forbidden"},
401 "schema": {"$ref": "#/definitions/ProblemDetails"},
402 "description": "Enrichment Information producer is not found"
407 "name": "eiProducerId",
408 "description": "eiProducerId",
412 "tags": ["Data Producer Registry API"]
415 "summary": "Individual EI producer",
417 "produces": ["application/json"],
418 "operationId": "deleteEiProducerUsingDELETE",
420 "200": {"description": "Not used"},
421 "401": {"description": "Unauthorized"},
422 "204": {"description": "Producer deleted"},
423 "403": {"description": "Forbidden"},
425 "schema": {"$ref": "#/definitions/ProblemDetails"},
426 "description": "Producer is not found"
431 "name": "eiProducerId",
432 "description": "eiProducerId",
436 "tags": ["Data Producer Registry API"]
439 "summary": "Individual EI producer",
441 "produces": ["application/json"],
442 "operationId": "putEiProducerUsingPUT",
444 "200": {"description": "Producer updated"},
445 "201": {"description": "Producer created"},
446 "401": {"description": "Unauthorized"},
447 "403": {"description": "Forbidden"},
448 "404": {"description": "Not Found"}
453 "name": "eiProducerId",
454 "description": "eiProducerId",
459 "schema": {"$ref": "#/definitions/producer_registration_info"},
461 "name": "registrationInfo",
462 "description": "registrationInfo",
466 "tags": ["Data Producer Registry API"],
467 "consumes": ["application/json"]
470 "/producer_simulator/health_check": {"get": {
471 "summary": "Producer supervision",
473 "produces": ["application/json"],
474 "operationId": "producerSupervisionUsingGET",
477 "schema": {"type": "string"},
480 "401": {"description": "Unauthorized"},
481 "403": {"description": "Forbidden"},
482 "404": {"description": "Not Found"}
484 "tags": ["Data Producer Job Control (example producer)"]
486 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
487 "summary": "EI job definitions",
489 "produces": ["application/json"],
490 "description": "EI job definitions for one EI producer",
491 "operationId": "getEiProducerJobsUsingGET",
496 "items": {"$ref": "#/definitions/producer_ei_job_request"}
498 "description": "EI producer"
500 "401": {"description": "Unauthorized"},
501 "403": {"description": "Forbidden"},
503 "schema": {"$ref": "#/definitions/ProblemDetails"},
504 "description": "Enrichment Information producer is not found"
509 "name": "eiProducerId",
510 "description": "eiProducerId",
514 "tags": ["Data Producer Registry API"]
516 "/A1-EI/v1/eijobs": {"get": {
517 "summary": "EI job identifiers",
519 "produces": ["application/json"],
520 "description": "query for EI job identifiers",
521 "operationId": "getEiJobIdsUsingGET",
526 "items": {"type": "string"}
528 "description": "EI job identifiers"
530 "401": {"description": "Unauthorized"},
531 "403": {"description": "Forbidden"},
533 "schema": {"$ref": "#/definitions/ProblemDetails"},
534 "description": "Enrichment Information type is not found"
540 "allowEmptyValue": false,
542 "description": "selects EI jobs of matching EI type",
548 "allowEmptyValue": false,
550 "description": "selects EI jobs for one EI job owner",
555 "tags": ["A1-EI (enrichment information)"]
557 "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
558 "summary": "EI job status",
560 "produces": ["application/json"],
561 "operationId": "getEiJobStatusUsingGET",
564 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
565 "description": "EI job status"
567 "401": {"description": "Unauthorized"},
568 "403": {"description": "Forbidden"},
570 "schema": {"$ref": "#/definitions/ProblemDetails"},
571 "description": "Enrichment Information job is not found"
577 "description": "eiJobId",
581 "tags": ["A1-EI (enrichment information)"]
585 "producer_ei_job_request": {
586 "description": "The body of the EI producer callbacks for EI job creation and deletion",
588 "title": "producer_ei_job_request",
589 "required": ["ei_job_identity"],
592 "description": "The owner of the job",
596 "description": "Idenitity of the EI job",
600 "description": "The time when the job was last updated or created (ISO-8601)",
604 "description": "Json for the job data",
608 "description": "URI for the target of the EI",
611 "ei_type_identity": {
612 "description": "Type idenitity for the job",
618 "description": "Information for an EI type",
620 "title": "EiTypeObject"
624 "title": "status_info",
628 "description": "Number of EI producers",
633 "description": "Number of EI jobs",
638 "description": "Number of EI types",
642 "description": "status text",
647 "producer_ei_type_info": {
648 "description": "Information for an EI type",
650 "title": "producer_ei_type_info",
651 "required": ["ei_job_data_schema"],
652 "properties": {"ei_job_data_schema": {
653 "description": "Json schema for the job data",
657 "producer_registration_info": {
658 "description": "Information for an EI producer",
660 "title": "producer_registration_info",
662 "ei_job_callback_url",
663 "ei_producer_supervision_callback_url",
667 "supported_ei_types": {
668 "description": "Supported EI type IDs",
670 "items": {"type": "string"}
672 "ei_producer_supervision_callback_url": {
673 "description": "callback for producer supervision",
676 "ei_job_callback_url": {
677 "description": "callback for EI job",
683 "description": "Status for an EI Producer",
685 "title": "producer_status",
686 "required": ["operational_state"],
687 "properties": {"operational_state": {
688 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
697 "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
699 "title": "ProblemDetails",
702 "description": "A human-readable explanation specific to this occurrence of the problem.",
704 "example": "EI job type not found"
708 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
714 "EiJobStatusObject": {
715 "description": "Status for an EI job",
717 "title": "EiJobStatusObject",
718 "required": ["eiJobStatus"],
719 "properties": {"eiJobStatus": {
720 "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",
729 "description": "Information for an Enrichment Information Job",
731 "title": "EiJobObject",
740 "description": "EI type Idenitifier of the EI job",
744 "description": "The target URI of the EI data",
748 "description": "Identity of the owner of the job",
751 "jobStatusNotificationUri": {
752 "description": "The target of EI job status notifications",
756 "description": "EI type specific job data",
764 "description": "This page lists all the rest apis for the service.",
765 "title": "Enrichment Data service",
770 "name": "A1-EI (enrichment information)",
771 "description": "Consumer Controller"
774 "name": "A1-EI (enrichment information) callbacks",
775 "description": "Consumer Simulator Controller"
778 "name": "Data Producer Job Control (example producer)",
779 "description": "Producer Simulator Controller"
782 "name": "Data Producer Registry API",
783 "description": "Producer Controller"
786 "name": "Service status",
787 "description": "Status Controller"