Module.yaml

displayName: 'Zaikio Output'
moduleName: 'zaikio-output'
description: 'Send requests to Zaikio API Mission Control.'
versionName: 'v1.0.0'
isPublic: true
categories:
  - 'Egress'
type: 'Output'     
image:
  name: 'weevenetwork/zaikio-output'
  tag: 'v1.0.0'                           
  homepage: 'https://hub.docker.com/r/weevenetwork/zaikio-output' 
repository: 'https://github.com/weeve-modules/zaikio-output'  
envs:                            
  - name: Personal Access Token      
    key: PERSONAL_ACCESS_TOKEN             
    description: Personal Access Token to Zaikio Mission Control.
    value: 'my-zaikio-mission-control-token'                     
    type: 'text'                   
    options: []
    dependencies: []
  - name: Zaikio Server      
    key: ZAIKIO_SERVER             
    description: Zaikio server to send requests to. Production (https://mc.zaikio.com/api/v1) or Sandbox Test Server (https://mc.sandbox.zaikio.com/api/v1).
    value: 'https://mc.sandbox.zaikio.com/api/v1'                     
    type: 'select'                   
    options:
      - 'https://mc.sandbox.zaikio.com/api/v1'
      - 'https://mc.zaikio.com/api/v1'
    dependencies: []
  - name: Endpoint      
    key: ENDPOINT             
    description: Zaikio API method and endpoint to send data to.
    value: 'POST /jobs'                     
    type: 'select'                   
    options:
      - 'POST /jobs/{job_id}/finished_product'
      - 'GET /jobs/{job_id}/finished_product'
      - 'PATCH /jobs/{job_id}/finished_product'
      - 'DELETE /jobs/{job_id}/finished_product'
      - 'GET /jobs'
      - 'POST /jobs'
      - 'PATCH /jobs/{job_id}'
      - 'DELETE /jobs/{job_id}'
      - 'GET /jobs/{job_id}'
      - 'POST /executions'
      - 'GET /executions'
      - 'PATCH /executions/{execution_id}'
      - 'GET /executions/{execution_id}'
      - 'DELETE /executions/{execution_id}'
    dependencies: []  
  - name: Object ID      
    key: OBJECT_ID             
    description: Provide object's ID if the above endpoint request needs Job ID or Execution ID.
    value: 'my-job-id'                     
    type: 'text'                   
    options: []
    dependencies:
      - key: ENDPOINT
        value: 'POST /jobs/{job_id}/finished_product'
      - key: ENDPOINT
        value: 'GET /jobs/{job_id}/finished_product'
      - key: ENDPOINT
        value: 'PATCH /jobs/{job_id}/finished_product'
      - key: ENDPOINT
        value: 'DELETE /jobs/{job_id}/finished_product'
      - key: ENDPOINT
        value: 'PATCH /jobs/{job_id}'
      - key: ENDPOINT
        value: 'DELETE /jobs/{job_id}'
      - key: ENDPOINT
        value: 'GET /jobs/{job_id}'     
      - key: ENDPOINT
        value: 'PATCH /executions/{execution_id}'
      - key: ENDPOINT
        value: 'GET /executions/{execution_id}'
      - key: ENDPOINT
        value: 'DELETE /executions/{execution_id}'
ports: []
envPorts: []
mounts: []
envMounts: []
devices: []
envDevices: []
tags:                                
  - 'Python'
  - 'Output'
  - 'Zaikio'
  - '1.0.0'
icon: 'https://icons-020-demo.s3.eu-central-1.amazonaws.com/mi_zaiko_ouput.png'