4 "/producer_simulator/supervision": {"get": {
5 "summary": "Producer supervision",
7 "produces": ["application/json"],
8 "operationId": "producerSupervisionUsingGET",
11 "schema": {"type": "string"},
14 "401": {"description": "Unauthorized"},
15 "403": {"description": "Forbidden"},
16 "404": {"description": "Not Found"}
18 "tags": ["Producer Callbacks"]
20 "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
21 "summary": "Individual EI type",
23 "produces": ["application/json"],
24 "operationId": "getEiTypeUsingGET",
27 "schema": {"$ref": "#/definitions/EiTypeObject"},
28 "description": "EI type"
30 "401": {"description": "Unauthorized"},
31 "403": {"description": "Forbidden"},
33 "schema": {"$ref": "#/definitions/ProblemDetails"},
34 "description": "Enrichment Information type is not found"
40 "description": "eiTypeId",
44 "tags": ["A1-EI (enrichment information)"]
46 "/consumer_simulator/eijobs/{eiJobId}/status": {"post": {
47 "summary": "Callback for EI job status",
49 "produces": ["application/json"],
50 "operationId": "jobStatusCallbackUsingPOST",
52 "200": {"description": "OK"},
53 "201": {"description": "Created"},
54 "401": {"description": "Unauthorized"},
55 "403": {"description": "Forbidden"},
56 "404": {"description": "Not Found"}
62 "description": "eiJobId",
67 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
70 "description": "status",
74 "tags": ["Consumer Callbacks"],
75 "consumes": ["application/json"]
77 "/ei-producer/v1/eitypes": {"get": {
78 "summary": "EI type identifiers",
80 "produces": ["application/json"],
81 "operationId": "getEiTypeIdentifiersUsingGET_1",
86 "items": {"type": "string"}
88 "description": "EI type identifiers"
90 "401": {"description": "Unauthorized"},
91 "403": {"description": "Forbidden"},
92 "404": {"description": "Not Found"}
94 "tags": ["Enrichment Data Producer API"]
96 "/A1-EI/v1/eitypes": {"get": {
97 "summary": "EI type identifiers",
99 "produces": ["application/json"],
100 "operationId": "getEiTypeIdentifiersUsingGET",
105 "items": {"type": "string"}
107 "description": "EI type identifiers"
109 "401": {"description": "Unauthorized"},
110 "403": {"description": "Forbidden"},
111 "404": {"description": "Not Found"}
113 "tags": ["A1-EI (enrichment information)"]
115 "/producer_simulator/job_deleted": {"post": {
116 "summary": "Callback for EI job deletion",
118 "produces": ["application/json"],
119 "operationId": "jobDeletedCallbackUsingPOST",
121 "200": {"description": "OK"},
122 "201": {"description": "Created"},
123 "401": {"description": "Unauthorized"},
124 "403": {"description": "Forbidden"},
125 "404": {"description": "Not Found"}
128 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
131 "description": "request",
134 "tags": ["Producer Callbacks"],
135 "consumes": ["application/json"]
137 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
138 "summary": "EI producer status",
140 "produces": ["application/json"],
141 "operationId": "getEiProducerStatusUsingGET",
144 "schema": {"$ref": "#/definitions/producer_status"},
145 "description": "EI jobs"
147 "401": {"description": "Unauthorized"},
148 "403": {"description": "Forbidden"},
150 "schema": {"$ref": "#/definitions/ProblemDetails"},
151 "description": "Enrichment Information producer is not found"
156 "name": "eiProducerId",
157 "description": "eiProducerId",
161 "tags": ["Enrichment Data Producer API"]
163 "/ei-producer/v1/eiproducers": {"get": {
164 "summary": "EI producer identifiers",
166 "produces": ["application/json"],
167 "operationId": "getEiProducerIdentifiersUsingGET",
172 "items": {"type": "string"}
174 "description": "EI producer identifiers"
176 "401": {"description": "Unauthorized"},
177 "403": {"description": "Forbidden"},
178 "404": {"description": "Not Found"}
180 "tags": ["Enrichment Data Producer API"]
182 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
183 "summary": "Individual EI type",
185 "produces": ["application/json"],
186 "operationId": "getEiTypeUsingGET_1",
189 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
190 "description": "EI type"
192 "401": {"description": "Unauthorized"},
193 "403": {"description": "Forbidden"},
195 "schema": {"$ref": "#/definitions/ProblemDetails"},
196 "description": "Enrichment Information type is not found"
202 "description": "eiTypeId",
206 "tags": ["Enrichment Data Producer API"]
209 "summary": "Returns status and statistics of this service",
211 "produces": ["application/json"],
212 "operationId": "getStatusUsingGET",
215 "schema": {"$ref": "#/definitions/status_info"},
216 "description": "Service is living"
218 "401": {"description": "Unauthorized"},
219 "403": {"description": "Forbidden"},
220 "404": {"description": "Not Found"}
222 "tags": ["Service status"]
224 "/A1-EI/v1/eijobs/{eiJobId}": {
226 "summary": "Individual EI job",
228 "produces": ["application/json"],
229 "operationId": "getIndividualEiJobUsingGET",
232 "schema": {"$ref": "#/definitions/EiJobObject"},
233 "description": "EI job"
235 "401": {"description": "Unauthorized"},
236 "403": {"description": "Forbidden"},
238 "schema": {"$ref": "#/definitions/ProblemDetails"},
239 "description": "Enrichment Information job is not found"
245 "description": "eiJobId",
249 "tags": ["A1-EI (enrichment information)"]
252 "summary": "Individual EI job",
254 "produces": ["application/json"],
255 "operationId": "deleteIndividualEiJobUsingDELETE",
257 "200": {"description": "Not used"},
258 "401": {"description": "Unauthorized"},
259 "204": {"description": "Job deleted"},
260 "403": {"description": "Forbidden"},
262 "schema": {"$ref": "#/definitions/ProblemDetails"},
263 "description": "Enrichment Information job is not found"
269 "description": "eiJobId",
273 "tags": ["A1-EI (enrichment information)"]
276 "summary": "Individual EI job",
278 "produces": ["application/json"],
279 "operationId": "putIndividualEiJobUsingPUT",
281 "200": {"description": "Job updated"},
282 "201": {"description": "Job created"},
283 "401": {"description": "Unauthorized"},
284 "403": {"description": "Forbidden"},
286 "schema": {"$ref": "#/definitions/ProblemDetails"},
287 "description": "Enrichment Information type is not found"
294 "description": "eiJobId",
299 "schema": {"$ref": "#/definitions/EiJobObject"},
301 "name": "eiJobObject",
302 "description": "eiJobObject",
306 "tags": ["A1-EI (enrichment information)"],
307 "consumes": ["application/json"]
310 "/ei-producer/v1/eiproducers/{eiProducerId}": {
312 "summary": "Individual EI producer",
314 "produces": ["application/json"],
315 "operationId": "getEiProducerUsingGET",
318 "schema": {"$ref": "#/definitions/producer_registration_info"},
319 "description": "EI jobs"
321 "401": {"description": "Unauthorized"},
322 "403": {"description": "Forbidden"},
324 "schema": {"$ref": "#/definitions/ProblemDetails"},
325 "description": "Enrichment Information producer is not found"
330 "name": "eiProducerId",
331 "description": "eiProducerId",
335 "tags": ["Enrichment Data Producer API"]
338 "summary": "Individual EI producer",
340 "produces": ["application/json"],
341 "operationId": "deleteEiProducerUsingDELETE",
343 "200": {"description": "Not used"},
344 "401": {"description": "Unauthorized"},
345 "204": {"description": "Producer deleted"},
346 "403": {"description": "Forbidden"},
348 "schema": {"$ref": "#/definitions/ProblemDetails"},
349 "description": "Producer is not found"
354 "name": "eiProducerId",
355 "description": "eiProducerId",
359 "tags": ["Enrichment Data Producer API"]
362 "summary": "Individual EI producer",
364 "produces": ["application/json"],
365 "operationId": "putEiProducerUsingPUT",
367 "200": {"description": "Producer updated"},
368 "201": {"description": "Producer created"},
369 "401": {"description": "Unauthorized"},
370 "403": {"description": "Forbidden"},
371 "404": {"description": "Not Found"}
376 "name": "eiProducerId",
377 "description": "eiProducerId",
382 "schema": {"$ref": "#/definitions/producer_registration_info"},
384 "name": "registrationInfo",
385 "description": "registrationInfo",
389 "tags": ["Enrichment Data Producer API"],
390 "consumes": ["application/json"]
393 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
394 "summary": "EI job definitions",
396 "produces": ["application/json"],
397 "description": "EI job definitions for one EI producer",
398 "operationId": "getEiProducerJobsUsingGET",
403 "items": {"$ref": "#/definitions/producer_ei_job_request"}
405 "description": "EI jobs"
407 "401": {"description": "Unauthorized"},
408 "403": {"description": "Forbidden"},
410 "schema": {"$ref": "#/definitions/ProblemDetails"},
411 "description": "Enrichment Information producer is not found"
416 "name": "eiProducerId",
417 "description": "eiProducerId",
421 "tags": ["Enrichment Data Producer API"]
423 "/A1-EI/v1/eijobs": {"get": {
424 "summary": "EI job identifiers",
426 "produces": ["application/json"],
427 "description": "query for EI job identifiers",
428 "operationId": "getEiJobIdsUsingGET",
433 "items": {"type": "string"}
435 "description": "EI job identifiers"
437 "401": {"description": "Unauthorized"},
438 "403": {"description": "Forbidden"},
440 "schema": {"$ref": "#/definitions/ProblemDetails"},
441 "description": "Enrichment Information type is not found"
447 "allowEmptyValue": false,
449 "description": "selects EI jobs of matching EI type",
455 "allowEmptyValue": false,
457 "description": "selects EI jobs for one EI job owner",
462 "tags": ["A1-EI (enrichment information)"]
464 "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
465 "summary": "EI job status",
467 "produces": ["application/json"],
468 "operationId": "getEiJobStatusUsingGET",
471 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
472 "description": "EI job status"
474 "401": {"description": "Unauthorized"},
475 "403": {"description": "Forbidden"},
477 "schema": {"$ref": "#/definitions/ProblemDetails"},
478 "description": "Enrichment Information job is not found"
484 "description": "eiJobId",
488 "tags": ["A1-EI (enrichment information)"]
490 "/producer_simulator/job_created": {"post": {
491 "summary": "Callback for EI job creation",
493 "produces": ["application/json"],
494 "operationId": "jobCreatedCallbackUsingPOST",
496 "200": {"description": "OK"},
497 "201": {"description": "Created"},
498 "401": {"description": "Unauthorized"},
499 "403": {"description": "Forbidden"},
500 "404": {"description": "Not Found"}
503 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
506 "description": "request",
509 "tags": ["Producer Callbacks"],
510 "consumes": ["application/json"]
513 "host": "localhost:38499",
515 "producer_ei_job_request": {
516 "description": "The body of the EI producer callbacks for EI job creation and deletion",
518 "title": "producer_ei_job_request",
519 "required": ["ei_job_identity"],
522 "description": "Idenitity of the EI job",
526 "description": "Json for the job data",
530 "description": "URI for the target of the EI",
533 "ei_type_identity": {
534 "description": "Type idenitity for the job",
540 "description": "Information for an EI type",
542 "title": "EiTypeObject"
544 "producer_ei_type_registration_info": {
545 "description": "Information for an EI type",
547 "title": "producer_ei_type_registration_info",
548 "required": ["ei_type_identity"],
550 "ei_type_identity": {
551 "description": "EI type identity",
554 "ei_job_data_schema": {
555 "description": "Json schema for the job data",
562 "title": "status_info",
566 "description": "Number of EI producers",
571 "description": "Number of EI jobs",
576 "description": "Number of EI types",
580 "description": "status text",
585 "Mono«ResponseEntity«object»»": {
587 "title": "Mono«ResponseEntity«object»»"
589 "producer_ei_type_info": {
590 "description": "Information for an EI type",
592 "title": "producer_ei_type_info",
595 "description": "Registered producers",
597 "items": {"type": "string"}
599 "ei_job_data_schema": {
600 "description": "Json schema for the job data",
605 "producer_registration_info": {
606 "description": "Information for an EI producer",
608 "title": "producer_registration_info",
610 "ei_job_creation_callback_url",
611 "ei_job_deletion_callback_url",
612 "ei_producer_supervision_callback_url",
616 "supported_ei_types": {
617 "description": "Supported EI types",
619 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
621 "ei_job_creation_callback_url": {
622 "description": "callback for job creation",
625 "ei_job_deletion_callback_url": {
626 "description": "callback for job deletion",
629 "ei_producer_supervision_callback_url": {
630 "description": "callback for producer supervision",
636 "description": "Status for an EI Producer",
638 "title": "producer_status",
639 "required": ["operational_state"],
640 "properties": {"operational_state": {
641 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
650 "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
652 "title": "ProblemDetails",
655 "description": "A human-readable explanation specific to this occurrence of the problem.",
657 "example": "EI job type not found"
661 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
668 "description": "Void/empty",
672 "EiJobStatusObject": {
673 "description": "Status for an EI job",
675 "title": "EiJobStatusObject",
676 "required": ["eiJobStatus"],
677 "properties": {"eiJobStatus": {
678 "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",
687 "description": "Information for an Enrichment Information Job",
689 "title": "EiJobObject",
698 "description": "EI type Idenitifier of the EI job",
702 "description": "The target URI of the EI data",
706 "description": "Identity of the owner of the job",
709 "jobStatusNotificationUri": {
710 "description": "The target of EI job status notifications",
714 "description": "EI type specific job data",
722 "description": "This page lists all the rest apis for the service.",
723 "title": "Enrichment Data service",
728 "name": "A1-EI (enrichment information)",
729 "description": "Consumer Controller"
732 "name": "Consumer Callbacks",
733 "description": "Consumer Simulator Controller"
736 "name": "Enrichment Data Producer API",
737 "description": "Producer Controller"
740 "name": "Producer Callbacks",
741 "description": "Producer Simulator Controller"
744 "name": "Service status",
745 "description": "Status Controller"