DAK API hub

Generate dak-api.html, the DAK API’s entry page, and the per-artefact .openapi.json / .displays.json sidecars.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

dak-postprocessing

What the DAK post-processing phase produces after the IG Publisher runs — the JSON/JSON-LD surface, the DAK API hub, and the metadata-to-Liquid bridge — and how an IG repository’s own site gets the same sidecars from the cached AST (ig-site:sidecars). Read before changing a post-processing step, and before assuming the Publisher produced something it did not.

Source: smart-base/L3/skills/smart-l3/dak-postprocessing.md.

Also satisfied by: smart-liquid-variables.

The skill declares no I/O contract (schemas/skills/dak-postprocessing/{input,output}.schema.json).

ig-artifact-ingestion

Source: smart-base/L3/skills/smart-l3/ig-artifact-ingestion.md.

The skill declares no I/O contract (schemas/skills/ig-artifact-ingestion/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
inigOutputRepoPathyesstring · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
outhubRepoPathdak-api.html.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
outsidecarsRepoPath.openapi.json and .displays.json under schemas/.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.

Processes and tasks

Steps this Tool can carry out, because each names a skill it satisfies:

processsteplanevia skill
SMART Guideline end to end4 · Create / adapt L2 DAK assetsAuthoring agentdak-postprocessing
SMART Guideline end to end5 · Choose L3 dependencies (WHO / jurisdiction IGs)Authoring agentig-artifact-ingestion

How it is deployed and reached

  • Command line. From the repository root: python3 input/scripts/generate_dak_api_hub.py.
  • GitHub Actions. No workflow in this checkout runs its command.

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimepython3
networkno
when to choose it
whenThe DAK API is to have a reader-facing entry point.
limitsdak-api.html links its schemas to a schemas/ directory that does not hold the root enumeration schemas. Resolve a sidecar from the index, never by composing the hub’s path.
costThe largest upstream script; runs inside the publisher container against the full output.

What it is made of

rolefile
scriptinput/scripts/generate_dak_api_hub.pynot in this checkout

Linked data

The Tool is published as its own JSON-LD document at its IRI, http://smart.who.int/base/tools/dak-api-hub.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "http://smart.who.int/base/smart-base.context.jsonld",
  "@id": "http://smart.who.int/base/tools/dak-api-hub.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "http://smart.who.int/base/smart-base.jsonld",
  "name": "dak-api-hub",
  "title": "DAK API hub",
  "description": "Generate `dak-api.html`, the DAK API's entry page, and the per-artefact `.openapi.json` / `.displays.json` sidecars.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "python3 input/scripts/generate_dak_api_hub.py"
  },
  "io": {
    "inputs": [
      {
        "name": "igOutput",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "required": true
      }
    ],
    "outputs": [
      {
        "name": "hub",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "`dak-api.html`."
      },
      {
        "name": "sidecars",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "`.openapi.json` and `.displays.json` under `schemas/`."
      }
    ]
  },
  "satisfies": [
    "dak-postprocessing",
    "ig-artifact-ingestion"
  ],
  "requirements": {
    "runtime": [
      "python3"
    ],
    "network": false
  },
  "selection": {
    "when": "The DAK API is to have a reader-facing entry point.",
    "limits": "`dak-api.html` links its schemas to a `schemas/` directory that does not hold the root enumeration schemas. Resolve a sidecar from the index, never by composing the hub's path.",
    "cost": "The largest upstream script; runs inside the publisher container against the full output."
  }
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev