4 "/producer_simulator/job_deleted_error": {"post": {
5 "summary": "Callback for EI job creation, returns error",
7 "produces": ["application/json"],
8 "operationId": "jobDeletedCallbackReturnErrorUsingPOST",
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 Simulator"],
24 "consumes": ["application/json"]
26 "/producer_simulator/supervision": {"get": {
27 "summary": "Producer supervision",
29 "produces": ["application/json"],
30 "operationId": "producerSupervisionUsingGET",
33 "schema": {"type": "string"},
36 "401": {"description": "Unauthorized"},
37 "403": {"description": "Forbidden"},
38 "404": {"description": "Not Found"}
40 "tags": ["Producer Simulator"]
42 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs": {"get": {
43 "summary": "EI job identifiers",
45 "produces": ["application/json"],
46 "operationId": "getEiJobIdsUsingGET",
51 "items": {"type": "string"}
53 "description": "EI job identifiers"
55 "401": {"description": "Unauthorized"},
56 "403": {"description": "Forbidden"},
58 "schema": {"$ref": "#/definitions/error_information"},
59 "description": "Enrichment Information type is not found"
66 "description": "eiTypeId",
71 "schema": {"type": "string"},
74 "description": "identifies the owner of the job",
78 "tags": ["A1-E Enrichment Data Consumer API"]
80 "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
81 "summary": "Individual EI type",
83 "produces": ["application/json"],
84 "operationId": "getEiTypeUsingGET",
87 "schema": {"$ref": "#/definitions/EiType"},
88 "description": "EI type"
90 "401": {"description": "Unauthorized"},
91 "403": {"description": "Forbidden"},
93 "schema": {"$ref": "#/definitions/error_information"},
94 "description": "Enrichment Information type is not found"
100 "description": "eiTypeId",
104 "tags": ["A1-E Enrichment Data Consumer API"]
106 "/ei-producer/v1/eitypes": {"get": {
107 "summary": "EI type identifiers",
109 "produces": ["application/json"],
110 "operationId": "getEiTypeIdentifiersUsingGET_1",
115 "items": {"type": "string"}
117 "description": "EI type identifiers"
119 "401": {"description": "Unauthorized"},
120 "403": {"description": "Forbidden"},
121 "404": {"description": "Not Found"}
123 "tags": ["Enrichment Data Producer API"]
125 "/A1-EI/v1/eitypes": {"get": {
126 "summary": "EI type identifiers",
128 "produces": ["application/json"],
129 "operationId": "getEiTypeIdentifiersUsingGET",
134 "items": {"type": "string"}
136 "description": "EI type identifiers"
138 "401": {"description": "Unauthorized"},
139 "403": {"description": "Forbidden"},
140 "404": {"description": "Not Found"}
142 "tags": ["A1-E Enrichment Data Consumer API"]
144 "/producer_simulator/job_deleted": {"post": {
145 "summary": "Callback for EI job deletion",
147 "produces": ["application/json"],
148 "operationId": "jobDeletedCallbackUsingPOST",
150 "200": {"description": "OK"},
151 "201": {"description": "Created"},
152 "401": {"description": "Unauthorized"},
153 "403": {"description": "Forbidden"},
154 "404": {"description": "Not Found"}
157 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
160 "description": "request",
163 "tags": ["Producer Simulator"],
164 "consumes": ["application/json"]
166 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status": {"get": {
167 "summary": "EI Job status",
169 "produces": ["application/json"],
170 "operationId": "getEiJobStatusUsingGET",
173 "schema": {"$ref": "#/definitions/EiJobStatus"},
174 "description": "EI Job status"
176 "401": {"description": "Unauthorized"},
177 "403": {"description": "Forbidden"},
179 "schema": {"$ref": "#/definitions/error_information"},
180 "description": "Enrichment Information type or job is not found"
187 "description": "eiJobId",
194 "description": "eiTypeId",
199 "tags": ["A1-E Enrichment Data Consumer API"]
201 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
202 "summary": "EI producer status",
204 "produces": ["application/json"],
205 "operationId": "getEiProducerStatusUsingGET",
208 "schema": {"$ref": "#/definitions/producer_status"},
209 "description": "EI jobs"
211 "401": {"description": "Unauthorized"},
212 "403": {"description": "Forbidden"},
214 "schema": {"$ref": "#/definitions/error_information"},
215 "description": "Enrichment Information producer is not found"
220 "name": "eiProducerId",
221 "description": "eiProducerId",
225 "tags": ["Enrichment Data Producer API"]
227 "/producer_simulator/supervision_error": {"get": {
228 "summary": "Producer supervision error",
230 "produces": ["application/json"],
231 "operationId": "producerSupervisionErrorUsingGET",
234 "schema": {"type": "string"},
237 "401": {"description": "Unauthorized"},
238 "403": {"description": "Forbidden"},
239 "404": {"description": "Not Found"}
241 "tags": ["Producer Simulator"]
243 "/ei-producer/v1/eiproducers": {"get": {
244 "summary": "EI producer identifiers",
246 "produces": ["application/json"],
247 "operationId": "getEiProducerIdentifiersUsingGET",
252 "items": {"type": "string"}
254 "description": "EI producer identifiers"
256 "401": {"description": "Unauthorized"},
257 "403": {"description": "Forbidden"},
258 "404": {"description": "Not Found"}
260 "tags": ["Enrichment Data Producer API"]
262 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
263 "summary": "Individual EI Type",
265 "produces": ["application/json"],
266 "operationId": "getEiTypeUsingGET_1",
269 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
270 "description": "EI type"
272 "401": {"description": "Unauthorized"},
273 "403": {"description": "Forbidden"},
275 "schema": {"$ref": "#/definitions/error_information"},
276 "description": "Enrichment Information type is not found"
282 "description": "eiTypeId",
286 "tags": ["Enrichment Data Producer API"]
289 "summary": "Returns status and statistics of this service",
291 "produces": ["application/json"],
292 "operationId": "getStatusUsingGET",
295 "schema": {"$ref": "#/definitions/status_info"},
296 "description": "Service is living"
298 "401": {"description": "Unauthorized"},
299 "403": {"description": "Forbidden"},
300 "404": {"description": "Not Found"}
302 "tags": ["Service status"]
304 "/producer_simulator/job_created_error": {"post": {
305 "summary": "Callback for EI job creation, returns error",
307 "produces": ["application/json"],
308 "operationId": "jobCreatedCallbackReturnErrorUsingPOST",
310 "200": {"description": "OK"},
311 "201": {"description": "Created"},
312 "401": {"description": "Unauthorized"},
313 "403": {"description": "Forbidden"},
314 "404": {"description": "Not Found"}
317 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
320 "description": "request",
323 "tags": ["Producer Simulator"],
324 "consumes": ["application/json"]
326 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}": {
328 "summary": "Individual EI Job",
330 "produces": ["application/json"],
331 "operationId": "getIndividualEiJobUsingGET",
334 "schema": {"$ref": "#/definitions/EiJob"},
335 "description": "EI Job"
337 "401": {"description": "Unauthorized"},
338 "403": {"description": "Forbidden"},
340 "schema": {"$ref": "#/definitions/error_information"},
341 "description": "Enrichment Information type or job is not found"
348 "description": "eiJobId",
355 "description": "eiTypeId",
360 "tags": ["A1-E Enrichment Data Consumer API"]
363 "summary": "Individual EI Job",
365 "produces": ["application/json"],
366 "operationId": "deleteIndividualEiJobUsingDELETE",
368 "200": {"description": "Not used"},
369 "401": {"description": "Unauthorized"},
370 "204": {"description": "Job deleted"},
371 "403": {"description": "Forbidden"},
373 "schema": {"$ref": "#/definitions/error_information"},
374 "description": "Enrichment Information type or job is not found"
381 "description": "eiJobId",
388 "description": "eiTypeId",
393 "tags": ["A1-E Enrichment Data Consumer API"]
396 "summary": "Individual EI Job",
398 "produces": ["application/json"],
399 "operationId": "putIndividualEiJobUsingPUT",
401 "200": {"description": "Job updated"},
402 "201": {"description": "Job created"},
403 "401": {"description": "Unauthorized"},
404 "403": {"description": "Forbidden"},
406 "schema": {"$ref": "#/definitions/error_information"},
407 "description": "Enrichment Information type is not found"
414 "description": "eiJobId",
419 "schema": {"$ref": "#/definitions/EiJob"},
422 "description": "eiJobInfo",
428 "description": "eiTypeId",
433 "tags": ["A1-E Enrichment Data Consumer API"],
434 "consumes": ["application/json"]
437 "/ei-producer/v1/eiproducers/{eiProducerId}": {
439 "summary": "Individual EI producer",
441 "produces": ["application/json"],
442 "operationId": "getEiProducerUsingGET",
445 "schema": {"$ref": "#/definitions/producer_registration_info"},
446 "description": "EI Jobs"
448 "401": {"description": "Unauthorized"},
449 "403": {"description": "Forbidden"},
451 "schema": {"$ref": "#/definitions/error_information"},
452 "description": "Enrichment Information producer is not found"
457 "name": "eiProducerId",
458 "description": "eiProducerId",
462 "tags": ["Enrichment Data Producer API"]
465 "summary": "Individual EI producer",
467 "produces": ["application/json"],
468 "operationId": "deleteEiProducerUsingDELETE",
470 "200": {"description": "Not used"},
471 "401": {"description": "Unauthorized"},
472 "204": {"description": "Producer deleted"},
473 "403": {"description": "Forbidden"},
475 "schema": {"$ref": "#/definitions/error_information"},
476 "description": "Producer is not found"
481 "name": "eiProducerId",
482 "description": "eiProducerId",
486 "tags": ["Enrichment Data Producer API"]
489 "summary": "Individual EI producer",
491 "produces": ["application/json"],
492 "operationId": "putEiProducerUsingPUT",
494 "200": {"description": "Producer updated"},
495 "201": {"description": "Producer created"},
496 "401": {"description": "Unauthorized"},
497 "403": {"description": "Forbidden"},
498 "404": {"description": "Not Found"}
503 "name": "eiProducerId",
504 "description": "eiProducerId",
509 "schema": {"$ref": "#/definitions/producer_registration_info"},
511 "name": "registrationInfo",
512 "description": "registrationInfo",
516 "tags": ["Enrichment Data Producer API"],
517 "consumes": ["application/json"]
520 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
521 "summary": "EI job definitions",
523 "produces": ["application/json"],
524 "description": "EI job definitions for one EI producer",
525 "operationId": "getEiProducerJobsUsingGET",
530 "items": {"$ref": "#/definitions/producer_ei_job_request"}
532 "description": "EI jobs"
534 "401": {"description": "Unauthorized"},
535 "403": {"description": "Forbidden"},
537 "schema": {"$ref": "#/definitions/error_information"},
538 "description": "Enrichment Information producer is not found"
543 "name": "eiProducerId",
544 "description": "eiProducerId",
548 "tags": ["Enrichment Data Producer API"]
550 "/producer_simulator/job_created": {"post": {
551 "summary": "Callback for EI job creation",
553 "produces": ["application/json"],
554 "operationId": "jobCreatedCallbackUsingPOST",
556 "200": {"description": "OK"},
557 "201": {"description": "Created"},
558 "401": {"description": "Unauthorized"},
559 "403": {"description": "Forbidden"},
560 "404": {"description": "Not Found"}
563 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
566 "description": "request",
569 "tags": ["Producer Simulator"],
570 "consumes": ["application/json"]
573 "host": "localhost:40973",
576 "description": "Information for an EI type",
579 "properties": {"eiJobParametersSchema": {
580 "description": "Json schema for the job data",
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": "Idenitity of the EI job",
595 "description": "Json for the job data",
599 "description": "URI for the target of the EI",
602 "ei_type_identity": {
603 "description": "Type idenitity for the job",
608 "error_information": {
609 "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
611 "title": "error_information",
614 "description": "A human-readable explanation specific to this occurrence of the problem.",
616 "example": "EI job type not found"
620 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
627 "description": "Void/empty",
632 "description": "Information for an Enrichment Information Job",
642 "description": "The target of the EI data",
646 "description": "Identity of the owner of the job",
650 "description": "EI Type specific job data",
655 "producer_ei_type_registration_info": {
656 "description": "Information for an EI type",
658 "title": "producer_ei_type_registration_info",
659 "required": ["ei_type_identity"],
661 "ei_type_identity": {
662 "description": "EI type identity",
665 "ei_job_data_schema": {
666 "description": "Json schema for the job data",
673 "title": "status_info",
677 "description": "Number of EI producers",
682 "description": "Number of EI jobs",
687 "description": "Number of EI types",
691 "description": "status text",
697 "description": "Status for an EI Job",
699 "title": "EiJobStatus",
700 "required": ["operationalState"],
701 "properties": {"operationalState": {
702 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
710 "Mono«ResponseEntity«object»»": {
712 "title": "Mono«ResponseEntity«object»»"
714 "producer_ei_type_info": {
715 "description": "Information for an EI type",
717 "title": "producer_ei_type_info",
720 "description": "Registered producers",
722 "items": {"type": "string"}
724 "ei_job_data_schema": {
725 "description": "Json schema for the job data",
730 "producer_registration_info": {
731 "description": "Information for an EI producer",
733 "title": "producer_registration_info",
735 "ei_job_creation_callback_url",
736 "ei_job_deletion_callback_url",
737 "ei_producer_supervision_callback_url",
741 "supported_ei_types": {
742 "description": "Supported EI types",
744 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
746 "ei_job_creation_callback_url": {
747 "description": "callback for job creation",
750 "ei_job_deletion_callback_url": {
751 "description": "callback for job deletion",
754 "ei_producer_supervision_callback_url": {
755 "description": "callback for producer supervision",
761 "description": "Status for an EI Producer",
763 "title": "producer_status",
764 "required": ["operational_state"],
765 "properties": {"operational_state": {
766 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
777 "description": "This page lists all the rest apis for the service.",
778 "title": "Enrichment Data service",
783 "name": "A1-E Enrichment Data Consumer API",
784 "description": "Consumer Controller"
787 "name": "Enrichment Data Producer API",
788 "description": "Producer Controller"
791 "name": "Producer Simulator",
792 "description": "Producer Simulator Controller"
795 "name": "Service status",
796 "description": "Status Controller"