Config for openhim

Jobs that use the openhim adaptor may require authentication. A "credential" for the openhim adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "apiUrl": "http://openhim.com/api"
}

Full Schema

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "apiUrl": {
          "title": "API URL",
          "type": "string",
          "description": "The OpenHIM API url",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "http://openhim.com/api"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "The username to log in to OpenHIM",
          "minLength": 1,
          "examples": [
              "admin@openhim.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "The password to log in to OpenHIM",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)Secretpass"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "apiUrl"
  ]
}