FOLIO · Schema

DeploymentDescriptor

Module deployment information. There are two modes: deployment managed by Okapi (with nodeId specified) and remote module (with URL specified).

CompanyLibraryLibrary Services PlatformOpen SourceMicroservicesEducation

Properties

Name Type Description
srvcId string The Module ID for the instance
instId string Instance ID (at least unique for node)
nodeId string Node ID where module is deployed
url string URL where module is deployed (not managed by Okapi)
descriptor object Deployment details
View JSON Schema on GitHub

JSON Schema

folio-deployment-descriptor-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$id": "https://artifacts.apis.io/folio/json-schema/folio-deployment-descriptor-schema.json",
  "title": "DeploymentDescriptor",
  "description": "Module deployment information. There are two modes: deployment managed by Okapi (with nodeId specified) and remote module (with URL specified).",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-deployment-api-openapi.yml#/components/schemas/DeploymentDescriptor",
  "id": "DeploymentDescriptor.json",
  "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"
    },
    "url": {
      "description": "URL where module is deployed (not managed by Okapi)",
      "type": "string"
    },
    "descriptor": {
      "description": "Deployment details",
      "$ref": "#/$defs/LaunchDescriptor"
    }
  },
  "required": [
    "srvcId"
  ],
  "$defs": {
    "LaunchDescriptor": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "LaunchDescriptor.json",
      "title": "LaunchDescriptor",
      "description": "Specifies how a module is deployed and undeployed",
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/folio-deployment-descriptor"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.