Fix typos in documentation
[nonrtric.git] / enrichment-coordinator-service / docs / api.yaml
index bb34e2b..f3fa767 100644 (file)
-swagger: '2.0'
-info:
-  description: This page lists all the rest apis for the service.
-  version: '1.0'
-  title: Enrichment Data service
-host: 'localhost:8081'
 basePath: /
-tags:
-  - name: A1-E Enrichment Data Consumer API
-    description: Consumer Controller
-  - name: Enrichment Data Producer API
-    description: Producer Controller
-  - name: Producer Simulator
-    description: Producer Simulator Controller
 paths:
-  /A1-EI/v1/eitypes:
-    get:
-      tags:
-        - A1-E Enrichment Data Consumer API
-      summary: Query EI type identifiers
-      description: DETAILS TBD
-      operationId: getEiTypeIdentifiersUsingGET
+  /producer_simulator/job_deleted_error:
+    post:
+      summary: 'Callback for EI job creation, returns error'
+      deprecated: false
       produces:
         - application/json
+      operationId: jobDeletedCallbackReturnErrorUsingPOST
       responses:
         '200':
-          description: EI type identifiers
-          schema:
-            type: array
-            items:
-              type: string
+          description: OK
+        '201':
+          description: Created
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
           description: Not Found
-      deprecated: false
-  '/A1-EI/v1/eitypes/{eiTypeId}':
-    get:
+      parameters:
+        - schema:
+            $ref: '#/definitions/producer_ei_job_request'
+          in: body
+          name: request
+          description: request
+          required: true
       tags:
-        - A1-E Enrichment Data Consumer API
-      summary: Definitions for an individual EI Type
-      description: Query EI type
-      operationId: getEiTypeUsingGET
+        - Producer Simulator
+      consumes:
+        - application/json
+  /producer_simulator/supervision:
+    get:
+      summary: Producer supervision
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
+      operationId: producerSupervisionUsingGET
       responses:
         '200':
-          description: EI type
           schema:
-            $ref: '#/definitions/ei_type_info'
+            type: string
+          description: OK
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type is not found
-          schema:
-            $ref: '#/definitions/error_information'
-      deprecated: false
+          description: Not Found
+      tags:
+        - Producer Simulator
   '/A1-EI/v1/eitypes/{eiTypeId}/eijobs':
     get:
-      tags:
-        - A1-E Enrichment Data Consumer API
-      summary: Query EI job identifiers
-      description: Returns the identifiers for an EI Type
-      operationId: getEiJobIdsUsingGET
+      summary: EI job identifiers
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
-        - in: body
-          name: owner
-          description: identifies the owner of the job
-          required: false
-          schema:
-            type: string
+      operationId: getEiJobIdsUsingGET
       responses:
         '200':
-          description: EI type
           schema:
             type: array
             items:
               type: string
+          description: EI job identifiers
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-  '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}':
-    get:
+          description: Enrichment Information type is not found
+      parameters:
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
+          type: string
+          required: true
+        - schema:
+            type: string
+          in: body
+          name: owner
+          description: identifies the owner of the job
+          required: false
       tags:
         - A1-E Enrichment Data Consumer API
-      summary: Individual EI Job
-      operationId: getIndividualEiJobUsingGET
+  '/A1-EI/v1/eitypes/{eiTypeId}':
+    get:
+      summary: Individual EI type
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiJobId
-          in: path
-          description: eiJobId
-          required: true
-          type: string
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
+      operationId: getEiTypeUsingGET
       responses:
         '200':
-          description: EI Job
           schema:
-            $ref: '#/definitions/ei_job_info'
+            $ref: '#/definitions/EiType'
+          description: EI type
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type or job is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-    put:
+          description: Enrichment Information type is not found
+      parameters:
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
+          type: string
+          required: true
       tags:
         - A1-E Enrichment Data Consumer API
-      summary: Individual EI Job
-      description: Create or update an EI Job
-      operationId: putIndividualEiJobUsingPUT
-      consumes:
-        - application/json
+  /ei-producer/v1/eitypes:
+    get:
+      summary: EI type identifiers
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiJobId
-          in: path
-          description: eiJobId
-          required: true
-          type: string
-        - in: body
-          name: eiJobInfo
-          description: eiJobInfo
-          required: true
-          schema:
-            $ref: '#/definitions/ei_job_info'
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
+      operationId: getEiTypeIdentifiersUsingGET_1
       responses:
         '200':
-          description: Job updated
-          schema:
-            type: object
-        '201':
-          description: Job created
           schema:
-            type: object
+            type: array
+            items:
+              type: string
+          description: EI type identifiers
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type is not found
-          schema:
-            $ref: '#/definitions/error_information'
-      deprecated: false
-    delete:
+          description: Not Found
       tags:
-        - A1-E Enrichment Data Consumer API
-      summary: Individual EI Job
-      description: Delete an EI job
-      operationId: deleteIndividualEiJobUsingDELETE
+        - Enrichment Data Producer API
+  /A1-EI/v1/eitypes:
+    get:
+      summary: EI type identifiers
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiJobId
-          in: path
-          description: eiJobId
-          required: true
-          type: string
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
+      operationId: getEiTypeIdentifiersUsingGET
       responses:
         '200':
-          description: Not used
           schema:
-            type: object
-        '204':
-          description: Job deleted
-          schema:
-            type: object
+            type: array
+            items:
+              type: string
+          description: EI type identifiers
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type or job is not found
-          schema:
-            $ref: '#/definitions/error_information'
+          description: Not Found
+      tags:
+        - A1-E Enrichment Data Consumer API
+  /producer_simulator/job_deleted:
+    post:
+      summary: Callback for EI job deletion
       deprecated: false
+      produces:
+        - application/json
+      operationId: jobDeletedCallbackUsingPOST
+      responses:
+        '200':
+          description: OK
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+      parameters:
+        - schema:
+            $ref: '#/definitions/producer_ei_job_request'
+          in: body
+          name: request
+          description: request
+          required: true
+      tags:
+        - Producer Simulator
+      consumes:
+        - application/json
   '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status':
     get:
-      tags:
-        - A1-E Enrichment Data Consumer API
       summary: EI Job status
-      operationId: getEiJobStatusUsingGET
+      deprecated: false
       produces:
         - application/json
+      operationId: getEiJobStatusUsingGET
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/EiJobStatus'
+          description: EI Job status
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          schema:
+            $ref: '#/definitions/error_information'
+          description: Enrichment Information type or job is not found
       parameters:
-        - name: eiJobId
-          in: path
+        - in: path
+          name: eiJobId
           description: eiJobId
-          required: true
           type: string
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
           required: true
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
           type: string
+          required: true
+      tags:
+        - A1-E Enrichment Data Consumer API
+  '/ei-producer/v1/eiproducers/{eiProducerId}/status':
+    get:
+      summary: EI producer status
+      deprecated: false
+      produces:
+        - application/json
+      operationId: getEiProducerStatusUsingGET
       responses:
         '200':
-          description: EI Job status
           schema:
-            $ref: '#/definitions/ei_job_status'
+            $ref: '#/definitions/producer_status'
+          description: EI jobs
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type or job is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-  /ei-producer/v1/eiproducers:
-    get:
+          description: Enrichment Information producer is not found
+      parameters:
+        - in: path
+          name: eiProducerId
+          description: eiProducerId
+          type: string
+          required: true
       tags:
         - Enrichment Data Producer API
-      summary: Query EI producer identifiers
-      description: DETAILS TBD
-      operationId: getEiProducerIdentifiersUsingGET
+  /producer_simulator/supervision_error:
+    get:
+      summary: Producer supervision error
+      deprecated: false
       produces:
         - application/json
+      operationId: producerSupervisionErrorUsingGET
       responses:
         '200':
-          description: EI producer identifiers
           schema:
-            type: array
-            items:
-              type: string
+            type: string
+          description: OK
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
           description: Not Found
-      deprecated: false
-  '/ei-producer/v1/eiproducers/{eiProducerId}':
-    get:
       tags:
-        - Enrichment Data Producer API
-      summary: Job definition for an individual EI producer
-      description: Query EI jobs
-      operationId: getEiProducerUsingGET
+        - Producer Simulator
+  /ei-producer/v1/eiproducers:
+    get:
+      summary: EI producer identifiers
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiProducerId
-          in: path
-          description: eiProducerId
-          required: true
-          type: string
+      operationId: getEiProducerIdentifiersUsingGET
       responses:
         '200':
-          description: EI Jobs
           schema:
-            $ref: '#/definitions/producer_ei_type_info'
+            type: array
+            items:
+              type: string
+          description: EI producer identifiers
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information producer is not found
-          schema:
-            $ref: '#/definitions/error_information'
-      deprecated: false
-    put:
+          description: Not Found
       tags:
         - Enrichment Data Producer API
-      summary: Definitions for an individual EI producer
-      description: Put EI producer
-      operationId: putEiProducerUsingPUT
-      consumes:
-        - application/json
+  '/ei-producer/v1/eitypes/{eiTypeId}':
+    get:
+      summary: Individual EI Type
+      deprecated: false
       produces:
         - application/json
+      operationId: getEiTypeUsingGET_1
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/producer_ei_type_info'
+          description: EI type
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          schema:
+            $ref: '#/definitions/error_information'
+          description: Enrichment Information type is not found
       parameters:
-        - name: eiProducerId
-          in: path
-          description: eiProducerId
-          required: true
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
           type: string
-        - in: body
-          name: registrationInfo
-          description: registrationInfo
           required: true
-          schema:
-            $ref: '#/definitions/producer_registration_info'
+      tags:
+        - Enrichment Data Producer API
+  /producer_simulator/job_created_error:
+    post:
+      summary: 'Callback for EI job creation, returns error'
+      deprecated: false
+      produces:
+        - application/json
+      operationId: jobCreatedCallbackReturnErrorUsingPOST
       responses:
         '200':
-          description: Producer updated
-          schema:
-            type: object
+          description: OK
         '201':
-          description: Producer created
-          schema:
-            type: object
+          description: Created
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
           description: Not Found
-      deprecated: false
-    delete:
+      parameters:
+        - schema:
+            $ref: '#/definitions/producer_ei_job_request'
+          in: body
+          name: request
+          description: request
+          required: true
       tags:
-        - Enrichment Data Producer API
-      summary: Individual EI Producer
-      description: Delete an EI Producer
-      operationId: deleteEiProducerUsingDELETE
+        - Producer Simulator
+      consumes:
+        - application/json
+  '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}':
+    get:
+      summary: Individual EI Job
+      deprecated: false
       produces:
         - application/json
+      operationId: getIndividualEiJobUsingGET
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/EiJob'
+          description: EI Job
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          schema:
+            $ref: '#/definitions/error_information'
+          description: Enrichment Information type or job is not found
       parameters:
-        - name: eiProducerId
-          in: path
-          description: eiProducerId
+        - in: path
+          name: eiJobId
+          description: eiJobId
+          type: string
           required: true
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
           type: string
+          required: true
+      tags:
+        - A1-E Enrichment Data Consumer API
+    delete:
+      summary: Individual EI Job
+      deprecated: false
+      produces:
+        - application/json
+      operationId: deleteIndividualEiJobUsingDELETE
       responses:
         '200':
           description: Not used
-          schema:
-            type: object
         '204':
-          description: Producer deleted
-          schema:
-            type: object
+          description: Job deleted
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Producer is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-  '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs':
-    get:
-      tags:
-        - Enrichment Data Producer API
-      summary: Job definition for an individual EI producer
-      description: Query EI producer jobs
-      operationId: getEiProducerJobsUsingGET
-      produces:
-        - application/json
+          description: Enrichment Information type or job is not found
       parameters:
-        - name: eiProducerId
-          in: path
-          description: eiProducerId
+        - in: path
+          name: eiJobId
+          description: eiJobId
+          type: string
           required: true
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
           type: string
+          required: true
+      tags:
+        - A1-E Enrichment Data Consumer API
+    put:
+      summary: Individual EI Job
+      deprecated: false
+      produces:
+        - application/json
+      operationId: putIndividualEiJobUsingPUT
       responses:
         '200':
-          description: EI jobs
-          schema:
-            type: array
-            items:
-              $ref: '#/definitions/producer_ei_job_request'
+          description: Job updated
+        '201':
+          description: Job created
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information producer is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-  /ei-producer/v1/eitypes:
-    get:
+          description: Enrichment Information type is not found
+      parameters:
+        - in: path
+          name: eiJobId
+          description: eiJobId
+          type: string
+          required: true
+        - schema:
+            $ref: '#/definitions/EiJob'
+          in: body
+          name: eiJobInfo
+          description: eiJobInfo
+          required: true
+        - in: path
+          name: eiTypeId
+          description: eiTypeId
+          type: string
+          required: true
       tags:
-        - Enrichment Data Producer API
-      summary: Query EI type identifiers
-      description: DETAILS TBD
-      operationId: getEiTypeIdentifiersUsingGET_1
+        - A1-E Enrichment Data Consumer API
+      consumes:
+        - application/json
+  '/ei-producer/v1/eiproducers/{eiProducerId}':
+    get:
+      summary: Individual EI producer
+      deprecated: false
       produces:
         - application/json
+      operationId: getEiProducerUsingGET
       responses:
         '200':
-          description: EI type identifiers
           schema:
-            type: array
-            items:
-              type: string
+            $ref: '#/definitions/producer_registration_info'
+          description: EI Jobs
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Not Found
-      deprecated: false
-  '/ei-producer/v1/eitypes/{eiTypeId}':
-    get:
+          schema:
+            $ref: '#/definitions/error_information'
+          description: Enrichment Information producer is not found
+      parameters:
+        - in: path
+          name: eiProducerId
+          description: eiProducerId
+          type: string
+          required: true
       tags:
         - Enrichment Data Producer API
-      summary: Definitions for an individual EI Type
-      description: Query EI type
-      operationId: getEiTypeUsingGET_1
+    delete:
+      summary: Individual EI producer
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - name: eiTypeId
-          in: path
-          description: eiTypeId
-          required: true
-          type: string
+      operationId: deleteEiProducerUsingDELETE
       responses:
         '200':
-          description: EI type
-          schema:
-            $ref: '#/definitions/producer_ei_type_info'
+          description: Not used
+        '204':
+          description: Producer deleted
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
-          description: Enrichment Information type is not found
           schema:
             $ref: '#/definitions/error_information'
-      deprecated: false
-  /producer_simulator/job_created:
-    post:
+          description: Producer is not found
+      parameters:
+        - in: path
+          name: eiProducerId
+          description: eiProducerId
+          type: string
+          required: true
       tags:
-        - Producer Simulator
-      summary: Callback for job creation
-      operationId: jobCreatedCallbackUsingPOST
-      consumes:
-        - application/json
+        - Enrichment Data Producer API
+    put:
+      summary: Individual EI producer
+      deprecated: false
       produces:
         - application/json
-      parameters:
-        - in: body
-          name: request
-          description: request
-          required: true
-          schema:
-            $ref: '#/definitions/producer_ei_job_request'
+      operationId: putEiProducerUsingPUT
       responses:
         '200':
-          description: OK
-          schema:
-            type: object
+          description: Producer updated
         '201':
-          description: Created
+          description: Producer created
         '401':
           description: Unauthorized
         '403':
           description: Forbidden
         '404':
           description: Not Found
-      deprecated: false
-  /producer_simulator/job_deleted:
-    post:
+      parameters:
+        - in: path
+          name: eiProducerId
+          description: eiProducerId
+          type: string
+          required: true
+        - schema:
+            $ref: '#/definitions/producer_registration_info'
+          in: body
+          name: registrationInfo
+          description: registrationInfo
+          required: true
       tags:
-        - Producer Simulator
-      summary: Callback for job deletion
-      operationId: jobDeletedCallbackUsingPOST
+        - Enrichment Data Producer API
       consumes:
         - application/json
+  '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs':
+    get:
+      summary: EI job definitions
+      deprecated: false
       produces:
         - application/json
+      description: EI job definitions for one EI producer
+      operationId: getEiProducerJobsUsingGET
+      responses:
+        '200':
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/producer_ei_job_request'
+          description: EI jobs
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          schema:
+            $ref: '#/definitions/error_information'
+          description: Enrichment Information producer is not found
       parameters:
-        - in: body
-          name: request
-          description: request
+        - in: path
+          name: eiProducerId
+          description: eiProducerId
+          type: string
           required: true
-          schema:
-            $ref: '#/definitions/producer_ei_job_request'
+      tags:
+        - Enrichment Data Producer API
+  /producer_simulator/job_created:
+    post:
+      summary: Callback for EI job creation
+      deprecated: false
+      produces:
+        - application/json
+      operationId: jobCreatedCallbackUsingPOST
       responses:
         '200':
           description: OK
-          schema:
-            type: object
         '201':
           description: Created
         '401':
@@ -516,120 +588,177 @@ paths:
           description: Forbidden
         '404':
           description: Not Found
-      deprecated: false
+      parameters:
+        - schema:
+            $ref: '#/definitions/producer_ei_job_request'
+          in: body
+          name: request
+          description: request
+          required: true
+      tags:
+        - Producer Simulator
+      consumes:
+        - application/json
+host: 'localhost:43453'
 definitions:
-  ei_job_info:
+  EiType:
+    description: Information for an EI type
     type: object
-    required:
-      - job_data
-      - owner
+    title: EiType
     properties:
-      job_data:
+      eiJobParametersSchema:
+        description: Json schema for the job data
         type: object
-        description: EI Type specific job data
-      owner:
-        type: string
-        description: Identity of the owner of the job
-    title: ei_job_info
-    description: Information for a Enrichment Information Job
-  ei_job_status:
+  producer_ei_job_request:
+    description: The body of the EI producer callbacks for EI job creation and deletion
     type: object
+    title: producer_ei_job_request
     required:
-      - operational_state
+      - ei_job_identity
     properties:
-      operational_state:
+      ei_job_identity:
+        description: Idenitity of the EI job
         type: string
-        description: |-
-          Operational state, values: 
-          ENABLED: TBD 
-          DISABLED: TBD.
-        enum:
-          - ENABLED
-          - DISABLED
-    title: ei_job_status
-    description: Status for an EI Job
-  ei_type_info:
-    type: object
-    properties:
-      job_data_schema:
+      ei_job_data:
+        description: Json for the job data
         type: object
-        description: Json schema for the job data
-    title: ei_type_info
-    description: Information for an EI type
+      target_uri:
+        description: URI for the target of the EI
+        type: string
+      ei_type_identity:
+        description: Type idenitity for the job
+        type: string
   error_information:
+    description: 'Problem as defined in https://tools.ietf.org/html/rfc7807'
     type: object
+    title: error_information
     properties:
       detail:
+        description: A human-readable explanation specific to this occurrence of the problem.
         type: string
         example: EI job type not found
-        description: ' A human-readable explanation specific to this occurrence of the problem.'
       status:
-        type: integer
         format: int32
-        example: 503
-        description: 'The HTTP status code generated by the origin server for this occurrence of the problem. '
-    title: error_information
-    description: 'Problem as defined in https://tools.ietf.org/html/rfc7807'
-  producer_ei_job_request:
+        description: The HTTP status code generated by the origin server for this occurrence of the problem.
+        type: integer
+        example: 404
+  void:
+    description: Void/empty
+    type: object
+    title: void
+  EiJob:
+    description: Information for an Enrichment Information Job
     type: object
+    title: EiJob
     required:
-      - identity
+      - jobOwner
+      - jobParameters
+      - targetUri
     properties:
-      identity:
+      targetUri:
+        description: The target of the EI data
         type: string
-        description: Json for the job data
-      job_data:
-        type: object
-        description: Json for the job data
-      type_identity:
+      jobOwner:
+        description: Identity of the owner of the job
         type: string
-        description: Type idenitity for the job
-    title: producer_ei_job_request
-    description: Information EI job start
-  producer_ei_type_info:
-    type: object
-    properties:
-      job_data_schema:
+      jobParameters:
+        description: EI Type specific job data
         type: object
-        description: Json schema for the job data
-      producer_ids:
-        type: array
-        description: Registered producers
-        items:
-          type: string
-    title: producer_ei_type_info
-    description: Information for an EI type
   producer_ei_type_registration_info:
+    description: Information for an EI type
     type: object
+    title: producer_ei_type_registration_info
     required:
       - ei_type_identity
     properties:
       ei_type_identity:
-        type: string
         description: EI type identity
-      job_data_schema:
-        type: object
+        type: string
+      ei_job_data_schema:
         description: Json schema for the job data
-    title: producer_ei_type_registration_info
+        type: object
+  EiJobStatus:
+    description: Status for an EI Job
+    type: object
+    title: EiJobStatus
+    required:
+      - operationalState
+    properties:
+      operationalState:
+        description: |-
+          Operational state, values:
+          ENABLED: TBD
+          DISABLED: TBD.
+        type: string
+        enum:
+          - ENABLED
+          - DISABLED
+  Mono«ResponseEntity«object»»:
+    type: object
+    title: Mono«ResponseEntity«object»»
+  producer_ei_type_info:
     description: Information for an EI type
+    type: object
+    title: producer_ei_type_info
+    properties:
+      ei_producer_ids:
+        description: Registered producers
+        type: array
+        items:
+          type: string
+      ei_job_data_schema:
+        description: Json schema for the job data
+        type: object
   producer_registration_info:
+    description: Information for an EI producer
     type: object
+    title: producer_registration_info
     required:
-      - job_creation_callback_url
-      - job_deletion_callback_url
+      - ei_job_creation_callback_url
+      - ei_job_deletion_callback_url
+      - ei_producer_supervision_callback_url
       - supported_ei_types
     properties:
-      job_creation_callback_url:
-        type: string
-        description: callback for job creation
-      job_deletion_callback_url:
-        type: string
-        description: callback for job deletion
       supported_ei_types:
-        type: array
         description: Supported EI types
+        type: array
         items:
           $ref: '#/definitions/producer_ei_type_registration_info'
-    title: producer_registration_info
-    description: Information for an EI Producer
+      ei_job_creation_callback_url:
+        description: callback for job creation
+        type: string
+      ei_job_deletion_callback_url:
+        description: callback for job deletion
+        type: string
+      ei_producer_supervision_callback_url:
+        description: callback for producer supervision
+        type: string
+  producer_status:
+    description: Status for an EI Producer
+    type: object
+    title: producer_status
+    required:
+      - operational_state
+    properties:
+      operational_state:
+        description: |-
+          Operational state, values:
+          ENABLED: TBD
+          DISABLED: TBD.
+        type: string
+        enum:
+          - ENABLED
+          - DISABLED
+swagger: '2.0'
+info:
+  description: This page lists all the rest apis for the service.
+  title: Enrichment Data service
+  version: '1.0'
+tags:
+  - name: A1-E Enrichment Data Consumer API
+    description: Consumer Controller
+  - name: Enrichment Data Producer API
+    description: Producer Controller
+  - name: Producer Simulator
+    description: Producer Simulator Controller