sushi-config.yaml → index.config.json#contentTypes.dak

Derive the DAK configuration from sushi-config.yaml plus repository and branch context.

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-preprocessing

What each DAK pre-processing step does before the IG Publisher runs, which steps exist only to feed the Publisher’s page index, and how the phase runs as the overlay on fhir-harness’s AST cache refresh (dak-pre-export.sh). Also which files in a DAK repository are authored and which are generated, and the SEMVER rule for DAK and IG versions. Read before changing, assuming or moving a pre-processing step.

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

Also satisfied by: dmn-to-html, dmn-to-questionnaire.

The skill declares no I/O contract (schemas/skills/dak-preprocessing/{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
insushiConfigRepoPathyessushi-config.yaml at the IG root.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
inbranchBranchSanitised branch name, for the publication and preview URLs.string · pattern ^[A-Za-z0-9][A-Za-z0-9._/-]*$ · A git branch name
outdakConfigRepoPathindex.config.json (contentTypes.dak).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-preprocessing

How it is deployed and reached

  • Command line. From the repository root: python3 input/scripts/generate_dak_from_sushi.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
whenA DAK repository has no configuration yet, or its branch context has changed.
limitsUpstream runs it twice, before and after the branch name is sanitised, as an ordering workaround. Run it once, after sanitising.
costSeconds. The whole DAK phase is gated on the file it writes, so a silent failure disables every later step.

What it is made of

rolefile
scriptinput/scripts/generate_dak_from_sushi.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-config-from-sushi.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-config-from-sushi.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "http://smart.who.int/base/smart-base.jsonld",
  "name": "dak-config-from-sushi",
  "title": "sushi-config.yaml → index.config.json#contentTypes.dak",
  "description": "Derive the DAK configuration from `sushi-config.yaml` plus repository and branch context.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "python3 input/scripts/generate_dak_from_sushi.py"
  },
  "io": {
    "inputs": [
      {
        "name": "sushiConfig",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "`sushi-config.yaml` at the IG root.",
        "required": true
      },
      {
        "name": "branch",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Branch",
        "description": "Sanitised branch name, for the publication and preview URLs.",
        "required": false
      }
    ],
    "outputs": [
      {
        "name": "dakConfig",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "`index.config.json` (`contentTypes.dak`)."
      }
    ]
  },
  "satisfies": [
    "dak-preprocessing"
  ],
  "requirements": {
    "runtime": [
      "python3"
    ],
    "network": false
  },
  "selection": {
    "when": "A DAK repository has no configuration yet, or its branch context has changed.",
    "limits": "Upstream runs it twice, before and after the branch name is sanitised, as an ordering workaround. Run it once, after sanitising.",
    "cost": "Seconds. The whole DAK phase is gated on the file it writes, so a silent failure disables every later step."
  }
}

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