Description

Deploy (launch process, start a container, etc) instance of a particular service, according to the deployment descriptor.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "DeploymentDescriptor",
  "description" : "Module deployment information. There are two modes: deployment managed by Okapi (with nodeId specified) and remote module (with url specified).",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "srvcId": {
      "description": "The Module ID for the instance",
      "type": "string"
    },
    "instId": {
       "description": "Instance ID (at least unique for node)",
       "type": "string"
    },
    "nodeId": {
      "description": "Node ID where module is deployed",
      "type": ["string", "null"]
    },
    "url": {
      "description": "URL where module is deployed (not managed by Okapi)",
      "type": ["string", "null"]
    },
    "descriptor" : {
      "description": "Deployment details",
      "$ref": "LaunchDescriptor.json"
    }
  },
  "required": ["srvcId"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Register instance under a specified service id

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "DeploymentDescriptor",
  "description" : "Module deployment information. There are two modes: deployment managed by Okapi (with nodeId specified) and remote module (with url specified).",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "srvcId": {
      "description": "The Module ID for the instance",
      "type": "string"
    },
    "instId": {
       "description": "Instance ID (at least unique for node)",
       "type": "string"
    },
    "nodeId": {
      "description": "Node ID where module is deployed",
      "type": ["string", "null"]
    },
    "url": {
      "description": "URL where module is deployed (not managed by Okapi)",
      "type": ["string", "null"]
    },
    "descriptor" : {
      "description": "Deployment details",
      "$ref": "LaunchDescriptor.json"
    }
  },
  "required": ["srvcId"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Add environment entry

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "EnvEntry",
  "description": "Environment Variable",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Key",
      "type": "string"
    },
    "value": {
      "description": "Value",
      "type": "string"
    },
    "description": {
      "description": "Description",
      "type": "string"
    }
  },
  "required": ["name"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Announce new module to the proxy. Once successful a module can be selected for a specific tenant.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ModuleDescriptor",
  "description": "A FOLIO Module",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "id": {
      "description": "Module ID with format product-semver",
      "type": "string"
    },
    "name": {
      "description": "Short name for module (should not include version)",
      "type": "string"
    },
    "tags" : {
      "description": "Module tags",
      "type" : ["array", "null"],
      "items" : {
        "description": "Module tag",
        "type": "string"
      }
    },
    "requires": {
      "description": "Required interfaces",
      "type": ["array", "null"],
      "items": {
        "$ref": "InterfaceReference.json"
      }
    },
    "provides": {
      "description": "Provided interfaces",
      "type": ["array", "null"],
      "items": {
        "$ref": "InterfaceDescriptor.json"
      }
    },
    "filters": {
      "description": "Provided filters",
      "type": "array",
      "items": {
        "$ref": "RoutingEntry.json"
      }
    },
    "permissionSets": {
      "description": "Module Permission Sets",
      "type": ["array", "null"],
      "items": {
        "$ref": "Permission.json"
      }
    },
    "uiDescriptor": {
      "description": "UI module descriptor",
      "$ref": "UiModuleDescriptor.json"
    },
    "launchDescriptor": {
      "description": "Default deployment for this module",
      "$ref": "LaunchDescriptor.json"
    }
  },
  "required": ["id"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Pull modules (i.e. Module Descriptors) from a remote repository. The PullDescriptor includes one or more URLs. And the operation will try all URLs in order until one succeeds. Hence, the URLs should be pointing to identical remote repositories.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PullDescriptor",
  "description": "Information controlling the pull facility",
  "type": "object",
  "properties": {
    "urls": {
      "description": "List of URLs from which Okapi attempts pulling",
      "type": "array",
      "items" : {
         "type" : "string"
      }
    }
  }
}

Request Example (application/json)

Responses

200 OK

OK

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Create a new tenant

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TenantDescriptor",
  "description": "Tenant information",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "id": {
      "description": "Tenant ID",
      "type": "string"
    },
    "name": {
      "description": "Tenant name",
      "type": "string"
    },
    "description": {
      "description": "Tenant description",
      "type": "string"
    }
  }
}

Request Example (application/json)

Responses

201 Created

Tenant has been created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

Description

Enable, disable or upgrade one or more modules for tenant. The request body and response body is of the same type TenantModuleDescriptorList. This list includes one or more modules to be enabled, disabled or upgraded. The request is the initial desired changes and the response is the list of changes that must be fulfilled to satisfy dependencies. This service will eventually partially replace /_/proxy/tenants/{tenant}/modules . It also allows enabling multiple modules in in one transaction. For simulate=true, the response, can be viewed as a recipe for what must be deployed (optionally) and enabled/disabled by the existing tenants-modules CRUD service.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TenantModuleDescriptorList",
  "description": "List of module transitions",
  "type": "array",
  "items": {
    "$ref": "TenantModuleDescriptor.json"
  }
}

Request Example (application/json)

Responses

200 OK

OK

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server error

Response Example (text/plain)

Description

Enable a module for tenant. Only the member 'id' from TenantModuleDescriptor is used in this operation. This call will eventually be replaced by the 'install' service.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TenantModuleDescriptor",
  "description": "Module transitions",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "id": {
      "description": "Module ID (or just product part)",
      "type": "string"
    },
    "from": {
      "description": "Original Module ID when transitioning from one module to another",
      "type": "string"
    },
    "action" : {
      "description": "Module action",
      "type" : "string",
      "enum" : [ "enable", "disable", "uptodate", "suggest", "conflict" ]
    },
    "message": {
      "description": "Diagnostic Message",
      "type": "string"
    }
  },
  "required" : ["id"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server error

Response Example (text/plain)

Description

Upgrade a module for a tenant. Enable new module and disable current module with new module ID in body and existing ID in path. This call will eventually be replaced by the 'install' service.

Request JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TenantModuleDescriptor",
  "description": "Module transitions",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "id": {
      "description": "Module ID (or just product part)",
      "type": "string"
    },
    "from": {
      "description": "Original Module ID when transitioning from one module to another",
      "type": "string"
    },
    "action" : {
      "description": "Module action",
      "type" : "string",
      "enum" : [ "enable", "disable", "uptodate", "suggest", "conflict" ]
    },
    "message": {
      "description": "Diagnostic Message",
      "type": "string"
    }
  },
  "required" : ["id"]
}

Request Example (application/json)

Responses

201 Created

Created

Response Example (application/json)

400 Bad Request

Client Error

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server Error

Response Example (text/plain)

Description

Check if newer modules of exist and upgrade for tenant. The response is a list of modules that should be enabled, disabled or upgraded to perform the upgrade.

Responses

200 OK

OK

Response Example (application/json)

400 Bad Request

Bad Request

Response Example (text/plain)

404 Not Found

Not Found

Response Example (text/plain)

500 Internal Server Error

Server error

Response Example (text/plain)