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",
72 "allowEmptyValue": false,
74 "description": "identifies the owner of the job",
79 "tags": ["A1-E Enrichment Data Consumer API"]
81 "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
82 "summary": "Individual EI type",
84 "produces": ["application/json"],
85 "operationId": "getEiTypeUsingGET",
88 "schema": {"$ref": "#/definitions/EiType"},
89 "description": "EI type"
91 "401": {"description": "Unauthorized"},
92 "403": {"description": "Forbidden"},
94 "schema": {"$ref": "#/definitions/error_information"},
95 "description": "Enrichment Information type is not found"
101 "description": "eiTypeId",
105 "tags": ["A1-E Enrichment Data Consumer API"]
107 "/ei-producer/v1/eitypes": {"get": {
108 "summary": "EI type identifiers",
110 "produces": ["application/json"],
111 "operationId": "getEiTypeIdentifiersUsingGET_1",
116 "items": {"type": "string"}
118 "description": "EI type identifiers"
120 "401": {"description": "Unauthorized"},
121 "403": {"description": "Forbidden"},
122 "404": {"description": "Not Found"}
124 "tags": ["Enrichment Data Producer API"]
126 "/A1-EI/v1/eitypes": {"get": {
127 "summary": "EI type identifiers",
129 "produces": ["application/json"],
130 "operationId": "getEiTypeIdentifiersUsingGET",
135 "items": {"type": "string"}
137 "description": "EI type identifiers"
139 "401": {"description": "Unauthorized"},
140 "403": {"description": "Forbidden"},
141 "404": {"description": "Not Found"}
143 "tags": ["A1-E Enrichment Data Consumer API"]
145 "/producer_simulator/job_deleted": {"post": {
146 "summary": "Callback for EI job deletion",
148 "produces": ["application/json"],
149 "operationId": "jobDeletedCallbackUsingPOST",
151 "200": {"description": "OK"},
152 "201": {"description": "Created"},
153 "401": {"description": "Unauthorized"},
154 "403": {"description": "Forbidden"},
155 "404": {"description": "Not Found"}
158 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
161 "description": "request",
164 "tags": ["Producer Simulator"],
165 "consumes": ["application/json"]
167 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status": {"get": {
168 "summary": "EI Job status",
170 "produces": ["application/json"],
171 "operationId": "getEiJobStatusUsingGET",
174 "schema": {"$ref": "#/definitions/EiJobStatus"},
175 "description": "EI Job status"
177 "401": {"description": "Unauthorized"},
178 "403": {"description": "Forbidden"},
180 "schema": {"$ref": "#/definitions/error_information"},
181 "description": "Enrichment Information type or job is not found"
188 "description": "eiJobId",
195 "description": "eiTypeId",
200 "tags": ["A1-E Enrichment Data Consumer API"]
202 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
203 "summary": "EI producer status",
205 "produces": ["application/json"],
206 "operationId": "getEiProducerStatusUsingGET",
209 "schema": {"$ref": "#/definitions/producer_status"},
210 "description": "EI jobs"
212 "401": {"description": "Unauthorized"},
213 "403": {"description": "Forbidden"},
215 "schema": {"$ref": "#/definitions/error_information"},
216 "description": "Enrichment Information producer is not found"
221 "name": "eiProducerId",
222 "description": "eiProducerId",
226 "tags": ["Enrichment Data Producer API"]
228 "/producer_simulator/supervision_error": {"get": {
229 "summary": "Producer supervision error",
231 "produces": ["application/json"],
232 "operationId": "producerSupervisionErrorUsingGET",
235 "schema": {"type": "string"},
238 "401": {"description": "Unauthorized"},
239 "403": {"description": "Forbidden"},
240 "404": {"description": "Not Found"}
242 "tags": ["Producer Simulator"]
244 "/ei-producer/v1/eiproducers": {"get": {
245 "summary": "EI producer identifiers",
247 "produces": ["application/json"],
248 "operationId": "getEiProducerIdentifiersUsingGET",
253 "items": {"type": "string"}
255 "description": "EI producer identifiers"
257 "401": {"description": "Unauthorized"},
258 "403": {"description": "Forbidden"},
259 "404": {"description": "Not Found"}
261 "tags": ["Enrichment Data Producer API"]
263 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
264 "summary": "Individual EI Type",
266 "produces": ["application/json"],
267 "operationId": "getEiTypeUsingGET_1",
270 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
271 "description": "EI type"
273 "401": {"description": "Unauthorized"},
274 "403": {"description": "Forbidden"},
276 "schema": {"$ref": "#/definitions/error_information"},
277 "description": "Enrichment Information type is not found"
283 "description": "eiTypeId",
287 "tags": ["Enrichment Data Producer API"]
290 "summary": "Returns status and statistics of this service",
292 "produces": ["application/json"],
293 "operationId": "getStatusUsingGET",
296 "schema": {"$ref": "#/definitions/status_info"},
297 "description": "Service is living"
299 "401": {"description": "Unauthorized"},
300 "403": {"description": "Forbidden"},
301 "404": {"description": "Not Found"}
303 "tags": ["Service status"]
305 "/producer_simulator/job_created_error": {"post": {
306 "summary": "Callback for EI job creation, returns error",
308 "produces": ["application/json"],
309 "operationId": "jobCreatedCallbackReturnErrorUsingPOST",
311 "200": {"description": "OK"},
312 "201": {"description": "Created"},
313 "401": {"description": "Unauthorized"},
314 "403": {"description": "Forbidden"},
315 "404": {"description": "Not Found"}
318 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
321 "description": "request",
324 "tags": ["Producer Simulator"],
325 "consumes": ["application/json"]
327 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}": {
329 "summary": "Individual EI Job",
331 "produces": ["application/json"],
332 "operationId": "getIndividualEiJobUsingGET",
335 "schema": {"$ref": "#/definitions/EiJob"},
336 "description": "EI Job"
338 "401": {"description": "Unauthorized"},
339 "403": {"description": "Forbidden"},
341 "schema": {"$ref": "#/definitions/error_information"},
342 "description": "Enrichment Information type or job is not found"
349 "description": "eiJobId",
356 "description": "eiTypeId",
361 "tags": ["A1-E Enrichment Data Consumer API"]
364 "summary": "Individual EI Job",
366 "produces": ["application/json"],
367 "operationId": "deleteIndividualEiJobUsingDELETE",
369 "200": {"description": "Not used"},
370 "401": {"description": "Unauthorized"},
371 "204": {"description": "Job deleted"},
372 "403": {"description": "Forbidden"},
374 "schema": {"$ref": "#/definitions/error_information"},
375 "description": "Enrichment Information type or job is not found"
382 "description": "eiJobId",
389 "description": "eiTypeId",
394 "tags": ["A1-E Enrichment Data Consumer API"]
397 "summary": "Individual EI Job",
399 "produces": ["application/json"],
400 "operationId": "putIndividualEiJobUsingPUT",
402 "200": {"description": "Job updated"},
403 "201": {"description": "Job created"},
404 "401": {"description": "Unauthorized"},
405 "403": {"description": "Forbidden"},
407 "schema": {"$ref": "#/definitions/error_information"},
408 "description": "Enrichment Information type is not found"
415 "description": "eiJobId",
420 "schema": {"$ref": "#/definitions/EiJob"},
423 "description": "eiJobInfo",
429 "description": "eiTypeId",
434 "tags": ["A1-E Enrichment Data Consumer API"],
435 "consumes": ["application/json"]
438 "/ei-producer/v1/eiproducers/{eiProducerId}": {
440 "summary": "Individual EI producer",
442 "produces": ["application/json"],
443 "operationId": "getEiProducerUsingGET",
446 "schema": {"$ref": "#/definitions/producer_registration_info"},
447 "description": "EI Jobs"
449 "401": {"description": "Unauthorized"},
450 "403": {"description": "Forbidden"},
452 "schema": {"$ref": "#/definitions/error_information"},
453 "description": "Enrichment Information producer is not found"
458 "name": "eiProducerId",
459 "description": "eiProducerId",
463 "tags": ["Enrichment Data Producer API"]
466 "summary": "Individual EI producer",
468 "produces": ["application/json"],
469 "operationId": "deleteEiProducerUsingDELETE",
471 "200": {"description": "Not used"},
472 "401": {"description": "Unauthorized"},
473 "204": {"description": "Producer deleted"},
474 "403": {"description": "Forbidden"},
476 "schema": {"$ref": "#/definitions/error_information"},
477 "description": "Producer is not found"
482 "name": "eiProducerId",
483 "description": "eiProducerId",
487 "tags": ["Enrichment Data Producer API"]
490 "summary": "Individual EI producer",
492 "produces": ["application/json"],
493 "operationId": "putEiProducerUsingPUT",
495 "200": {"description": "Producer updated"},
496 "201": {"description": "Producer created"},
497 "401": {"description": "Unauthorized"},
498 "403": {"description": "Forbidden"},
499 "404": {"description": "Not Found"}
504 "name": "eiProducerId",
505 "description": "eiProducerId",
510 "schema": {"$ref": "#/definitions/producer_registration_info"},
512 "name": "registrationInfo",
513 "description": "registrationInfo",
517 "tags": ["Enrichment Data Producer API"],
518 "consumes": ["application/json"]
521 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
522 "summary": "EI job definitions",
524 "produces": ["application/json"],
525 "description": "EI job definitions for one EI producer",
526 "operationId": "getEiProducerJobsUsingGET",
531 "items": {"$ref": "#/definitions/producer_ei_job_request"}
533 "description": "EI jobs"
535 "401": {"description": "Unauthorized"},
536 "403": {"description": "Forbidden"},
538 "schema": {"$ref": "#/definitions/error_information"},
539 "description": "Enrichment Information producer is not found"
544 "name": "eiProducerId",
545 "description": "eiProducerId",
549 "tags": ["Enrichment Data Producer API"]
551 "/producer_simulator/job_created": {"post": {
552 "summary": "Callback for EI job creation",
554 "produces": ["application/json"],
555 "operationId": "jobCreatedCallbackUsingPOST",
557 "200": {"description": "OK"},
558 "201": {"description": "Created"},
559 "401": {"description": "Unauthorized"},
560 "403": {"description": "Forbidden"},
561 "404": {"description": "Not Found"}
564 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
567 "description": "request",
570 "tags": ["Producer Simulator"],
571 "consumes": ["application/json"]
574 "host": "localhost:45709",
577 "description": "Information for an EI type",
580 "properties": {"eiJobParametersSchema": {
581 "description": "Json schema for the job data",
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": "Idenitity of the EI job",
596 "description": "Json for the job data",
600 "description": "URI for the target of the EI",
603 "ei_type_identity": {
604 "description": "Type idenitity for the job",
609 "error_information": {
610 "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
612 "title": "error_information",
615 "description": "A human-readable explanation specific to this occurrence of the problem.",
617 "example": "EI job type not found"
621 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
628 "description": "Void/empty",
633 "description": "Information for an Enrichment Information Job",
643 "description": "The target of the EI data",
647 "description": "Identity of the owner of the job",
651 "description": "EI Type specific job data",
656 "producer_ei_type_registration_info": {
657 "description": "Information for an EI type",
659 "title": "producer_ei_type_registration_info",
660 "required": ["ei_type_identity"],
662 "ei_type_identity": {
663 "description": "EI type identity",
666 "ei_job_data_schema": {
667 "description": "Json schema for the job data",
674 "title": "status_info",
678 "description": "Number of EI producers",
683 "description": "Number of EI jobs",
688 "description": "Number of EI types",
692 "description": "status text",
698 "description": "Status for an EI Job",
700 "title": "EiJobStatus",
701 "required": ["operationalState"],
702 "properties": {"operationalState": {
703 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
711 "Mono«ResponseEntity«object»»": {
713 "title": "Mono«ResponseEntity«object»»"
715 "producer_ei_type_info": {
716 "description": "Information for an EI type",
718 "title": "producer_ei_type_info",
721 "description": "Registered producers",
723 "items": {"type": "string"}
725 "ei_job_data_schema": {
726 "description": "Json schema for the job data",
731 "producer_registration_info": {
732 "description": "Information for an EI producer",
734 "title": "producer_registration_info",
736 "ei_job_creation_callback_url",
737 "ei_job_deletion_callback_url",
738 "ei_producer_supervision_callback_url",
742 "supported_ei_types": {
743 "description": "Supported EI types",
745 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
747 "ei_job_creation_callback_url": {
748 "description": "callback for job creation",
751 "ei_job_deletion_callback_url": {
752 "description": "callback for job deletion",
755 "ei_producer_supervision_callback_url": {
756 "description": "callback for producer supervision",
762 "description": "Status for an EI Producer",
764 "title": "producer_status",
765 "required": ["operational_state"],
766 "properties": {"operational_state": {
767 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
778 "description": "This page lists all the rest apis for the service.",
779 "title": "Enrichment Data service",
784 "name": "A1-E Enrichment Data Consumer API",
785 "description": "Consumer Controller"
788 "name": "Enrichment Data Producer API",
789 "description": "Producer Controller"
792 "name": "Producer Simulator",
793 "description": "Producer Simulator Controller"
796 "name": "Service status",
797 "description": "Status Controller"