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 "/ei-producer/v1/eitypes": {"get": {
47 "summary": "EI type identifiers",
49 "produces": ["application/json"],
50 "operationId": "getEiTypeIdentifiersUsingGET_1",
55 "items": {"type": "string"}
57 "description": "EI type identifiers"
59 "401": {"description": "Unauthorized"},
60 "403": {"description": "Forbidden"},
61 "404": {"description": "Not Found"}
63 "tags": ["Enrichment Data Producer API"]
65 "/A1-EI/v1/eitypes": {"get": {
66 "summary": "EI type identifiers",
68 "produces": ["application/json"],
69 "operationId": "getEiTypeIdentifiersUsingGET",
74 "items": {"type": "string"}
76 "description": "EI type identifiers"
78 "401": {"description": "Unauthorized"},
79 "403": {"description": "Forbidden"},
80 "404": {"description": "Not Found"}
82 "tags": ["A1-EI (enrichment information)"]
84 "/producer_simulator/job_deleted": {"post": {
85 "summary": "Callback for EI job deletion",
87 "produces": ["application/json"],
88 "operationId": "jobDeletedCallbackUsingPOST",
90 "200": {"description": "OK"},
91 "201": {"description": "Created"},
92 "401": {"description": "Unauthorized"},
93 "403": {"description": "Forbidden"},
94 "404": {"description": "Not Found"}
97 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
100 "description": "request",
103 "tags": ["Producer Callbacks"],
104 "consumes": ["application/json"]
106 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
107 "summary": "EI producer status",
109 "produces": ["application/json"],
110 "operationId": "getEiProducerStatusUsingGET",
113 "schema": {"$ref": "#/definitions/producer_status"},
114 "description": "EI jobs"
116 "401": {"description": "Unauthorized"},
117 "403": {"description": "Forbidden"},
119 "schema": {"$ref": "#/definitions/ProblemDetails"},
120 "description": "Enrichment Information producer is not found"
125 "name": "eiProducerId",
126 "description": "eiProducerId",
130 "tags": ["Enrichment Data Producer API"]
132 "/ei-producer/v1/eiproducers": {"get": {
133 "summary": "EI producer identifiers",
135 "produces": ["application/json"],
136 "operationId": "getEiProducerIdentifiersUsingGET",
141 "items": {"type": "string"}
143 "description": "EI producer identifiers"
145 "401": {"description": "Unauthorized"},
146 "403": {"description": "Forbidden"},
147 "404": {"description": "Not Found"}
149 "tags": ["Enrichment Data Producer API"]
151 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
152 "summary": "Individual EI type",
154 "produces": ["application/json"],
155 "operationId": "getEiTypeUsingGET_1",
158 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
159 "description": "EI type"
161 "401": {"description": "Unauthorized"},
162 "403": {"description": "Forbidden"},
164 "schema": {"$ref": "#/definitions/ProblemDetails"},
165 "description": "Enrichment Information type is not found"
171 "description": "eiTypeId",
175 "tags": ["Enrichment Data Producer API"]
178 "summary": "Returns status and statistics of this service",
180 "produces": ["application/json"],
181 "operationId": "getStatusUsingGET",
184 "schema": {"$ref": "#/definitions/status_info"},
185 "description": "Service is living"
187 "401": {"description": "Unauthorized"},
188 "403": {"description": "Forbidden"},
189 "404": {"description": "Not Found"}
191 "tags": ["Service status"]
193 "/A1-EI/v1/eijobs/{eiJobId}": {
195 "summary": "Individual EI job",
197 "produces": ["application/json"],
198 "operationId": "getIndividualEiJobUsingGET",
201 "schema": {"$ref": "#/definitions/EiJobObject"},
202 "description": "EI job"
204 "401": {"description": "Unauthorized"},
205 "403": {"description": "Forbidden"},
207 "schema": {"$ref": "#/definitions/ProblemDetails"},
208 "description": "Enrichment Information job is not found"
214 "description": "eiJobId",
218 "tags": ["A1-EI (enrichment information)"]
221 "summary": "Individual EI job",
223 "produces": ["application/json"],
224 "operationId": "deleteIndividualEiJobUsingDELETE",
226 "200": {"description": "Not used"},
227 "401": {"description": "Unauthorized"},
228 "204": {"description": "Job deleted"},
229 "403": {"description": "Forbidden"},
231 "schema": {"$ref": "#/definitions/ProblemDetails"},
232 "description": "Enrichment Information job is not found"
238 "description": "eiJobId",
242 "tags": ["A1-EI (enrichment information)"]
245 "summary": "Individual EI job",
247 "produces": ["application/json"],
248 "operationId": "putIndividualEiJobUsingPUT",
250 "200": {"description": "Job updated"},
251 "201": {"description": "Job created"},
252 "401": {"description": "Unauthorized"},
253 "403": {"description": "Forbidden"},
255 "schema": {"$ref": "#/definitions/ProblemDetails"},
256 "description": "Enrichment Information type is not found"
263 "description": "eiJobId",
268 "schema": {"$ref": "#/definitions/EiJobObject"},
270 "name": "eiJobObject",
271 "description": "eiJobObject",
275 "tags": ["A1-EI (enrichment information)"],
276 "consumes": ["application/json"]
279 "/ei-producer/v1/eiproducers/{eiProducerId}": {
281 "summary": "Individual EI producer",
283 "produces": ["application/json"],
284 "operationId": "getEiProducerUsingGET",
287 "schema": {"$ref": "#/definitions/producer_registration_info"},
288 "description": "EI jobs"
290 "401": {"description": "Unauthorized"},
291 "403": {"description": "Forbidden"},
293 "schema": {"$ref": "#/definitions/ProblemDetails"},
294 "description": "Enrichment Information producer is not found"
299 "name": "eiProducerId",
300 "description": "eiProducerId",
304 "tags": ["Enrichment Data Producer API"]
307 "summary": "Individual EI producer",
309 "produces": ["application/json"],
310 "operationId": "deleteEiProducerUsingDELETE",
312 "200": {"description": "Not used"},
313 "401": {"description": "Unauthorized"},
314 "204": {"description": "Producer deleted"},
315 "403": {"description": "Forbidden"},
317 "schema": {"$ref": "#/definitions/ProblemDetails"},
318 "description": "Producer is not found"
323 "name": "eiProducerId",
324 "description": "eiProducerId",
328 "tags": ["Enrichment Data Producer API"]
331 "summary": "Individual EI producer",
333 "produces": ["application/json"],
334 "operationId": "putEiProducerUsingPUT",
336 "200": {"description": "Producer updated"},
337 "201": {"description": "Producer created"},
338 "401": {"description": "Unauthorized"},
339 "403": {"description": "Forbidden"},
340 "404": {"description": "Not Found"}
345 "name": "eiProducerId",
346 "description": "eiProducerId",
351 "schema": {"$ref": "#/definitions/producer_registration_info"},
353 "name": "registrationInfo",
354 "description": "registrationInfo",
358 "tags": ["Enrichment Data Producer API"],
359 "consumes": ["application/json"]
362 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
363 "summary": "EI job definitions",
365 "produces": ["application/json"],
366 "description": "EI job definitions for one EI producer",
367 "operationId": "getEiProducerJobsUsingGET",
372 "items": {"$ref": "#/definitions/producer_ei_job_request"}
374 "description": "EI jobs"
376 "401": {"description": "Unauthorized"},
377 "403": {"description": "Forbidden"},
379 "schema": {"$ref": "#/definitions/ProblemDetails"},
380 "description": "Enrichment Information producer is not found"
385 "name": "eiProducerId",
386 "description": "eiProducerId",
390 "tags": ["Enrichment Data Producer API"]
392 "/A1-EI/v1/eijobs": {"get": {
393 "summary": "EI job identifiers",
395 "produces": ["application/json"],
396 "description": "query for EI job identifiers",
397 "operationId": "getEiJobIdsUsingGET",
402 "items": {"type": "string"}
404 "description": "EI job identifiers"
406 "401": {"description": "Unauthorized"},
407 "403": {"description": "Forbidden"},
409 "schema": {"$ref": "#/definitions/ProblemDetails"},
410 "description": "Enrichment Information type is not found"
416 "allowEmptyValue": false,
418 "description": "selects EI jobs of matching EI type",
424 "allowEmptyValue": false,
426 "description": "selects EI jobs for one EI job owner",
431 "tags": ["A1-EI (enrichment information)"]
433 "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
434 "summary": "EI job status",
436 "produces": ["application/json"],
437 "operationId": "getEiJobStatusUsingGET",
440 "schema": {"$ref": "#/definitions/EiJobStatusObject"},
441 "description": "EI job status"
443 "401": {"description": "Unauthorized"},
444 "403": {"description": "Forbidden"},
446 "schema": {"$ref": "#/definitions/ProblemDetails"},
447 "description": "Enrichment Information job is not found"
453 "description": "eiJobId",
457 "tags": ["A1-EI (enrichment information)"]
459 "/producer_simulator/job_created": {"post": {
460 "summary": "Callback for EI job creation",
462 "produces": ["application/json"],
463 "operationId": "jobCreatedCallbackUsingPOST",
465 "200": {"description": "OK"},
466 "201": {"description": "Created"},
467 "401": {"description": "Unauthorized"},
468 "403": {"description": "Forbidden"},
469 "404": {"description": "Not Found"}
472 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
475 "description": "request",
478 "tags": ["Producer Callbacks"],
479 "consumes": ["application/json"]
482 "host": "localhost:42127",
484 "producer_ei_job_request": {
485 "description": "The body of the EI producer callbacks for EI job creation and deletion",
487 "title": "producer_ei_job_request",
488 "required": ["ei_job_identity"],
491 "description": "Idenitity of the EI job",
495 "description": "Json for the job data",
499 "description": "URI for the target of the EI",
502 "ei_type_identity": {
503 "description": "Type idenitity for the job",
509 "description": "Information for an EI type",
511 "title": "EiTypeObject"
513 "producer_ei_type_registration_info": {
514 "description": "Information for an EI type",
516 "title": "producer_ei_type_registration_info",
517 "required": ["ei_type_identity"],
519 "ei_type_identity": {
520 "description": "EI type identity",
523 "ei_job_data_schema": {
524 "description": "Json schema for the job data",
531 "title": "status_info",
535 "description": "Number of EI producers",
540 "description": "Number of EI jobs",
545 "description": "Number of EI types",
549 "description": "status text",
554 "Mono«ResponseEntity«object»»": {
556 "title": "Mono«ResponseEntity«object»»"
558 "producer_ei_type_info": {
559 "description": "Information for an EI type",
561 "title": "producer_ei_type_info",
564 "description": "Registered producers",
566 "items": {"type": "string"}
568 "ei_job_data_schema": {
569 "description": "Json schema for the job data",
574 "producer_registration_info": {
575 "description": "Information for an EI producer",
577 "title": "producer_registration_info",
579 "ei_job_creation_callback_url",
580 "ei_job_deletion_callback_url",
581 "ei_producer_supervision_callback_url",
585 "supported_ei_types": {
586 "description": "Supported EI types",
588 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
590 "ei_job_creation_callback_url": {
591 "description": "callback for job creation",
594 "ei_job_deletion_callback_url": {
595 "description": "callback for job deletion",
598 "ei_producer_supervision_callback_url": {
599 "description": "callback for producer supervision",
605 "description": "Status for an EI Producer",
607 "title": "producer_status",
608 "required": ["operational_state"],
609 "properties": {"operational_state": {
610 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
619 "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
621 "title": "ProblemDetails",
624 "description": "A human-readable explanation specific to this occurrence of the problem.",
626 "example": "EI job type not found"
630 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
637 "description": "Void/empty",
641 "EiJobStatusObject": {
642 "description": "Status for an EI job",
644 "title": "EiJobStatusObject",
645 "required": ["eiJobStatus"],
646 "properties": {"eiJobStatus": {
647 "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",
656 "description": "Information for an Enrichment Information Job",
658 "title": "EiJobObject",
667 "description": "EI type Idenitifier of the EI job",
671 "description": "The target URI of the EI data",
675 "description": "Identity of the owner of the job",
678 "jobStatusNotificationUri": {
679 "description": "The target of EI job status notifications",
683 "description": "EI type specific job data",
691 "description": "This page lists all the rest apis for the service.",
692 "title": "Enrichment Data service",
697 "name": "A1-EI (enrichment information)",
698 "description": "Consumer Controller"
701 "name": "Enrichment Data Producer API",
702 "description": "Producer Controller"
705 "name": "Producer Callbacks",
706 "description": "Producer Simulator Controller"
709 "name": "Service status",
710 "description": "Status Controller"