@shortlink-org/portolan 0.1.0

package/schema/portolan.schema.json

@@ -0,0 +1,2558 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/shortlink-org/portolan/schema/portolan.schema.json",
+  "title": "portolan manifest",
+  "description": "Where the facts come from, what produces them, and what turns them into something to read. Generated by scripts/schema.mjs from the plugins this manifest declares; run `npm run schema` after changing them.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "sources"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "$comment": {
+      "type": "string"
+    },
+    "sources": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      },
+      "description": "Globs of the catalog fragments that make up the estate. They are merged, then validated as a union, so a fragment naming a peer it does not own is normal rather than broken."
+    },
+    "defaultCatalog": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+      "description": "Catalog profile selected when the URL does not name one."
+    },
+    "catalogs": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/catalogProfile"
+      },
+      "description": "Independent presentations of the available fragments. Each profile is merged, enriched and validated on its own."
+    },
+    "projects": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/project"
+      },
+      "description": "The source projects that make up the estate. A project gives repeated pipeline inputs one name for the generated site's Settings page; estate-wide inputs such as flows need no project."
+    },
+    "plugins": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/plugin"
+      },
+      "description": "How to run each plugin. A step names one by the name declared here."
+    },
+    "extract": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "plugin",
+          "in",
+          "out"
+        ],
+        "properties": {
+          "plugin": {
+            "enum": [
+              "project",
+              "commands",
+              "go-domain",
+              "ts-domain",
+              "rust-domain",
+              "java-domain",
+              "django-domain",
+              "celery",
+              "python-kafka",
+              "openapi",
+              "wsdl",
+              "http-clients",
+              "redis",
+              "river",
+              "watermill",
+              "go-nats",
+              "asyncapi",
+              "graphql",
+              "sql",
+              "adr",
+              "glossary",
+              "flows",
+              "bsr",
+              "git",
+              "proto"
+            ],
+            "description": "A plugin declared above, one that belongs in this phase."
+          },
+          "in": {
+            "type": "string",
+            "description": "The directory to read, relative to the repository."
+          },
+          "out": {
+            "type": "string",
+            "description": "Where what comes back is written. A plugin names files; nothing it names is allowed to land outside this directory."
+          },
+          "options": {
+            "type": "object",
+            "description": "Passed to the plugin unread. What it accepts is described below."
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "project"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.project"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "commands"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.commands"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "go-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.go-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "ts-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.ts-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "rust-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.rust-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "java-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.java-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "django-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.django-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "celery"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.celery"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "python-kafka"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.python-kafka"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "openapi"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.openapi"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "wsdl"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.wsdl"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "http-clients"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.http-clients"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "redis"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.redis"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "river"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.river"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "watermill"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.watermill"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "go-nats"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.go-nats"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "asyncapi"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.asyncapi"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "graphql"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.graphql"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "sql"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.sql"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "adr"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.adr"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "glossary"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.glossary"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "flows"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.flows"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "bsr"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.bsr"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "git"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.git"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "proto"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.proto"
+                }
+              }
+            }
+          }
+        ]
+      },
+      "description": "Steps that read source and write catalog fragments. They run first, before there is a catalog."
+    },
+    "verify": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "plugin",
+          "in",
+          "out"
+        ],
+        "properties": {
+          "plugin": {
+            "enum": [
+              "otel",
+              "codeowners"
+            ],
+            "description": "A plugin declared above, one that belongs in this phase."
+          },
+          "in": {
+            "type": "string",
+            "description": "The directory to read, relative to the repository."
+          },
+          "out": {
+            "type": "string",
+            "description": "Where what comes back is written. A plugin names files; nothing it names is allowed to land outside this directory."
+          },
+          "options": {
+            "type": "object",
+            "description": "Passed to the plugin unread. What it accepts is described below."
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "otel"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.otel"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "codeowners"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.codeowners"
+                }
+              }
+            }
+          }
+        ]
+      },
+      "description": "Steps that read something observed - traces, a test's record - and answer with a fragment about the catalog somebody else declared."
+    },
+    "generate": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "plugin",
+          "out"
+        ],
+        "properties": {
+          "plugin": {
+            "enum": [
+              "markdown",
+              "mermaid",
+              "backstage"
+            ],
+            "description": "A plugin declared above, one that belongs in this phase."
+          },
+          "catalog": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Catalog profile supplied to this generator."
+          },
+          "out": {
+            "type": "string",
+            "description": "Where what comes back is written. A plugin names files; nothing it names is allowed to land outside this directory."
+          },
+          "options": {
+            "type": "object",
+            "description": "Passed to the plugin unread. What it accepts is described below."
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "markdown"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.markdown"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "mermaid"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.mermaid"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "backstage"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.backstage"
+                }
+              }
+            }
+          }
+        ]
+      },
+      "description": "Steps that read the merged catalog and write something to read."
+    }
+  },
+  "$defs": {
+    "catalogProfile": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "title",
+        "sources",
+        "contexts",
+        "projects"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+          "description": "Stable profile id used in URLs and generator steps."
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "sources": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string"
+          },
+          "description": "Catalog fragment globs merged for this profile."
+        },
+        "contexts": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Top-level catalog groups visible in this profile."
+        },
+        "projects": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Project ids belonging to this profile."
+        }
+      }
+    },
+    "project": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "root"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+          "description": "Stable id used to associate pipeline inputs with this project."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable project name shown in the generated site."
+        },
+        "root": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Repository-relative root. A pipeline input at or below this path belongs to the project."
+        },
+        "context": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Legacy alias for group. Kept so existing manifests remain valid."
+        },
+        "service": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Legacy alias for component. Kept so existing manifests remain valid."
+        },
+        "group": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Neutral top-level group this project contributes to."
+        },
+        "component": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Component slug inside the group."
+        },
+        "groupKind": {
+          "enum": [
+            "bounded-context",
+            "system",
+            "product",
+            "team",
+            "namespace"
+          ],
+          "description": "Semantic role of the project's top-level group."
+        },
+        "componentKind": {
+          "enum": [
+            "service",
+            "application",
+            "webapp",
+            "worker",
+            "job",
+            "function",
+            "cli",
+            "library",
+            "data-pipeline"
+          ],
+          "description": "Runtime or code role of the project component."
+        },
+        "repository": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Repository page or clone URL, when the project comes from another repository."
+        }
+      }
+    },
+    "plugin": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name"
+      ],
+      "oneOf": [
+        {
+          "required": [
+            "wasm"
+          ]
+        },
+        {
+          "required": [
+            "process"
+          ]
+        }
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "What the steps below call this plugin. It need not be the plugin's own name."
+        },
+        "wasm": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "url"
+          ],
+          "description": "The default. The module gets no filesystem, no network and no environment, so a plugin from somebody else's repository can be run over your source tree without reading it.",
+          "properties": {
+            "url": {
+              "type": "string",
+              "pattern": "^(https://|file://)",
+              "description": "https:// to download, or file:// for a path beside the manifest, as in file://plugins/gen-markdown.wasm."
+            },
+            "sha256": {
+              "type": "string",
+              "pattern": "^[0-9a-f]{64}$",
+              "description": "Checksum of the module. Required for a download; optional for a local file, which it does not protect."
+            }
+          }
+        },
+        "process": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "command"
+          ],
+          "description": "The escape hatch for a plugin that needs a toolchain. Same protocol, none of the sandbox, which is the trade being made.",
+          "properties": {
+            "command": {
+              "type": "string",
+              "minLength": 1,
+              "description": "The executable to run. It is passed directly to the OS, never through a shell."
+            },
+            "args": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Arguments passed to the executable without shell parsing."
+            }
+          }
+        }
+      }
+    },
+    "options.project": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "group": {
+          "type": "string",
+          "description": "Slug of the neutral top-level group. Defaults to the input directory name."
+        },
+        "groupName": {
+          "type": "string",
+          "description": "Human-readable group name. Defaults to the group slug, titled."
+        },
+        "groupSummary": {
+          "type": "string",
+          "description": "A short statement of what the group is responsible for."
+        },
+        "groupKind": {
+          "enum": [
+            "bounded-context",
+            "system",
+            "product",
+            "team",
+            "namespace"
+          ],
+          "description": "Semantic role of the top-level group. Defaults to system for this neutral extractor."
+        },
+        "component": {
+          "type": "string",
+          "description": "Slug of the component. Defaults to the input directory name."
+        },
+        "componentName": {
+          "type": "string",
+          "description": "Human-readable component name. Defaults to the README title and then the slug, titled."
+        },
+        "componentKind": {
+          "enum": [
+            "service",
+            "application",
+            "webapp",
+            "worker",
+            "job",
+            "function",
+            "cli",
+            "library",
+            "data-pipeline"
+          ],
+          "description": "Runtime or code role. When absent, the extractor uses conservative repository evidence."
+        },
+        "technologies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Languages and frameworks, stated when the tree cannot say: a component whose manifests sit above its root, one of several in a repository, has nothing at its root to read. Left out, inferred from go.mod, package.json, Cargo.toml and the like at the root."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Source repository identity. Defaults to a Go module, package.json repository, Cargo package, or Maven coordinates when present."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file inside the step output directory.",
+          "default": "project.json"
+        }
+      }
+    },
+    "options.commands": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context the service is in. Left out, the name of the input directory's parent, which is right for shop/cart and wrong for a repository of its own.",
+          "examples": [
+            "auth",
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service the commands belong to. Left out, the name of the input directory.",
+          "examples": [
+            "cart",
+            "pricing"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. Left out, commands.json."
+        }
+      }
+    },
+    "options.go-domain": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. A Go module knows its import path, not which context owns it. Defaults to the name of the input directory.",
+          "examples": [
+            "auth",
+            "shop"
+          ]
+        },
+        "contextName": {
+          "type": "string",
+          "description": "What the context is called on the page. Defaults to the slug, titled.",
+          "examples": [
+            "Authentication"
+          ]
+        },
+        "contextSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the context is responsible for. Read on the context page and nowhere else."
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the context is core to the business, supports it, or is generic and could be bought."
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "auth"
+          ]
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "What the service is called on the page. Defaults to the title of its README, and failing that to the slug, titled."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to the module path in go.mod.",
+          "examples": [
+            "github.com/shortlink-org/portolan"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database this service keeps its state in, the same one the sql extractor is given. It is here for the flows: a call on a repository lands somewhere, and only the manifest knows where.",
+          "examples": [
+            "pg"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for what this one calls, as the callee's package to its service id: a proto package for a gRPC client, the api id (the document's title and major version, `auth.v1`) for a generated HTTP client. The generated client names the package and the operation; only the manifest knows whose it is. A package with no line here is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "risk.v1": "shop.risk",
+              "auth.v1": "auth.auth"
+            }
+          ]
+        },
+        "externals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which system outside the estate answers to an api this service calls, as the api id to the external's bare id. Left out, a generated HTTP client whose package no peers line claims is read as calling the system its vendored document is titled after: a document titled \"Stripe API\" makes the external stripe.",
+          "examples": [
+            {
+              "stripe.v1": "stripe"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which aggregate another service's events belong to, as the import path a policy reads them from to the aggregate id, so a policy reacting to a foreign event resolves.",
+          "examples": [
+            {
+              "github.com/acme/shop/pricing/internal/infrastructure/cart": "shop.cart.basket"
+            }
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. One extractor writes one file, so that a fragment carries the provenance of the run that produced it.",
+          "default": "domain.json"
+        }
+      }
+    },
+    "options.ts-domain": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "contextName": {
+          "type": "string",
+          "description": "What the context is called on the page. Defaults to the slug, titled."
+        },
+        "contextSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the context is responsible for."
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the context is core to the business, supports it, or is generic and could be bought."
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "cart"
+          ]
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "What the service is called on the page. Defaults to the title of its README, and failing that to the slug, titled."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to the repository field of package.json.",
+          "examples": [
+            "github.com/shortlink-org/portolan"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database this service keeps its state in, the same one the sql extractor is given. It is here for the flows: a call on a repository lands somewhere, and only the manifest knows where.",
+          "examples": [
+            "pg"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for what this one calls, as the callee's package to its service id: the api id for an HTTP peer, the proto package for a gRPC one. A package with no line here is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "auth.v1": "auth.auth",
+              "shop.v1": "shop.pricing"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which aggregate another service's events belong to, as the import specifier a policy reads them from to the aggregate id, so a policy reacting to a foreign event resolves.",
+          "examples": [
+            {
+              "@acme/payments-events": "payments.ledger.payment"
+            }
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "The directory the layout starts in, relative to the input root.",
+          "default": "src"
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "domain.json"
+        },
+        "graphql": {
+          "type": "string",
+          "description": "Where the GraphQL schema is, relative to the input root, for a service whose way in is a graph: its resolvers are read as endpoints, and no domain is expected under src/domain.",
+          "examples": [
+            "src/schema"
+          ]
+        }
+      }
+    },
+    "options.rust-domain": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. A crate knows its name, not which context owns it. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "contextName": {
+          "type": "string",
+          "description": "What the context is called on the page. Defaults to the slug, titled.",
+          "examples": [
+            "Shop"
+          ]
+        },
+        "contextSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the context is responsible for. Read on the context page and nowhere else."
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the context is core to the business, supports it, or is generic and could be bought."
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "oms"
+          ]
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "What the service is called on the page. Defaults to the title of its README, and failing that to the slug, titled."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to the repository in Cargo.toml.",
+          "examples": [
+            "github.com/shortlink-org/portolan"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database this service keeps its state in, the same one the sql extractor is given. It is here for the flows: a call on a repository lands somewhere, and only the manifest knows where.",
+          "examples": [
+            "pg"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for what this one calls, as the callee's proto package to its service id. The generated client names the package and the rpc; only the manifest knows whose it is. A package with no line here is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "payments.v1": "payments.ledger"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Where another service's events are decoded in this crate, as the module path to the aggregate id they belong to: a policy reacting to a type from that module reacts to that aggregate's event. Without a line the step is unresolved.",
+          "examples": [
+            {
+              "crate::infrastructure::cart": "shop.cart.basket"
+            }
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "The directory the layout starts in, relative to the input root.",
+          "default": "src"
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. One extractor writes one file, so that a fragment carries the provenance of the run that produced it.",
+          "default": "domain.json"
+        }
+      }
+    },
+    "options.java-domain": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "payments"
+          ]
+        },
+        "contextName": {
+          "type": "string",
+          "description": "What the context is called on the page. Defaults to the slug, titled."
+        },
+        "contextSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the context is responsible for."
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the context is core to the business, supports it, or is generic and could be bought."
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "ledger"
+          ]
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "What the service is called on the page. Defaults to the title of its README, and failing that to the slug, titled."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to the scm url in pom.xml.",
+          "examples": [
+            "github.com/shortlink-org/portolan"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database this service keeps its state in, the same one the sql extractor is given. It is here for the flows: a call on a port lands somewhere, and only the manifest knows where.",
+          "examples": [
+            "pg"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for what this one calls, as the contract vendored beside the adapter to the callee's service id: the proto package for a gRPC peer, the api id of the OpenAPI document (its x-portolan-api, or its title and major version) for an HTTP one. A package with no line here, and none under externals, is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "shop.v1": "shop.oms",
+              "pricing.v1": "shop.pricing"
+            }
+          ]
+        },
+        "externals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which system outside the estate answers for what this one calls, as the api id of the document vendored beside the adapter to the external's id - the same bare name the openapi extractor is given under external. The calls land on the operations the copy declares and are declared, not unresolved; the lane says the far end is outside.",
+          "examples": [
+            {
+              "stripe.v1": "stripe"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which aggregate another service's events belong to, as the package a listener reads them from to the aggregate id, so a policy reacting to a foreign event resolves.",
+          "examples": [
+            {
+              "org.portolan.payments.ledger.infrastructure.oms.event": "shop.oms.order"
+            }
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "The directory the packages start in, relative to the input root.",
+          "default": "src/main/java"
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "domain.json"
+        }
+      }
+    },
+    "options.django-domain": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "contextName": {
+          "type": "string",
+          "description": "What the context is called on the page. Defaults to the slug, titled."
+        },
+        "contextSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the context is responsible for."
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the context is core to the business, supports it, or is generic and could be bought."
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "What the service is called on the page. Defaults to the title of its README, and failing that to the slug, titled."
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to the repository url in pyproject.toml.",
+          "examples": [
+            "github.com/shortlink-org/portolan"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database this service keeps its state in. Defaults from the kind of DATABASES['default'] when that setting is statically readable. The models are read as its schema, and a call into the ORM lands on its lane.",
+          "examples": [
+            "pg"
+          ]
+        },
+        "storeName": {
+          "type": "string",
+          "description": "What the database is called on the page. Defaults to the service, titled, and the word database."
+        },
+        "storeKind": {
+          "enum": [
+            "postgres",
+            "mysql",
+            "sqlite",
+            "redis",
+            "mongodb",
+            "clickhouse",
+            "s3",
+            "other"
+          ],
+          "description": "Which database the models are the schema of. Read off DATABASES['default']['ENGINE'] in the settings module when left out; given here, it wins, and a disagreement with the settings is reported. It picks the column types a field becomes; only postgres has a mapping, and a kind without one keeps the field's own name and says so."
+        },
+        "apps": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The Django applications to read, as import packages, for a project that keeps them somewhere a models module would not be found. Every package holding one is read when this is left out.",
+          "examples": [
+            [
+              "billing.invoices"
+            ]
+          ]
+        },
+        "aggregates": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which model is the root of an application's aggregate, as the application to the model. Only needed where the application is not named after its root - `invoices` finds `Invoice` on its own.",
+          "examples": [
+            {
+              "invoices": "Invoice"
+            }
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for what this one calls, as the api id of the document vendored beside the client to the callee's service id. A client with no line here is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "pricing.v1": "shop.pricing"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which aggregate another service's events belong to, as the module a receiver imports the signal from to the aggregate id, so a policy reacting to a foreign event resolves.",
+          "examples": [
+            {
+              "payments.events": "payments.ledger.payment"
+            }
+          ]
+        },
+        "flowWrappers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "label": {
+                "type": "string",
+                "description": "Business-facing label shown instead of expanding the wrapper's implementation. Defaults to the callable name, titled."
+              },
+              "target": {
+                "type": "string",
+                "description": "Service id the wrapper calls. Omit for a semantic operation inside this service."
+              },
+              "technical": {
+                "type": "boolean",
+                "default": false,
+                "description": "Collapse every call to this wrapper in one flow into one counted step."
+              }
+            }
+          },
+          "description": "Project callables that form a meaningful flow boundary, keyed as module.function or module.Class.method. Their internals are replaced by one semantic step; technical wrappers are also deduplicated per flow.",
+          "examples": [
+            {
+              "util.logger.send_log": {
+                "label": "Record application log",
+                "technical": true
+              },
+              "mailer.client.send": {
+                "label": "Send email",
+                "target": "messaging.mailer"
+              }
+            }
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "The directory the applications are looked for in, relative to the input root.",
+          "default": "."
+        },
+        "settings": {
+          "type": "string",
+          "description": "The Django settings module Celery is configured from, as an import spells it, so an enqueue lands on the queue the routes give it. Defaults to what manage.py sets DJANGO_SETTINGS_MODULE to.",
+          "examples": [
+            "config.settings"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "domain.json"
+        },
+        "storesOut": {
+          "type": "string",
+          "description": "Name of the fragment holding the database the models describe, inside the step's output directory. Written when store is set or inferred from DATABASES['default'].",
+          "default": "stores.json"
+        },
+        "openapiOut": {
+          "type": "string",
+          "description": "Name of the inferred OpenAPI 3.1 document, inside the step's output directory. Written when URLConf exposes HTTP operations.",
+          "default": "openapi.inferred.yaml"
+        }
+      }
+    },
+    "options.celery": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context the service belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service that enqueues and works the tasks. Defaults to the name of the input directory.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "The directory the tasks and their callers are looked for in, relative to the input root.",
+          "default": "."
+        },
+        "settings": {
+          "type": "string",
+          "description": "The Django settings module the Celery app is configured from, as an import spells it. Defaults to what manage.py sets DJANGO_SETTINGS_MODULE to.",
+          "examples": [
+            "config.settings"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "celery.json"
+        }
+      }
+    },
+    "options.python-kafka": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context the service belongs to. Defaults to the input directory name.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service that uses Kafka. Defaults to the input directory name.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "Python source directory to inspect, relative to the input root.",
+          "default": "."
+        },
+        "settings": {
+          "type": "string",
+          "description": "Optional settings module used to resolve values referenced as settings.NAME.",
+          "examples": [
+            "config.settings"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Fragment filename inside the extraction step output directory.",
+          "default": "kafka.json"
+        }
+      }
+    },
+    "options.openapi": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context that owns the service this document belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "auth"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service the document describes. Defaults to the name of the input directory.",
+          "examples": [
+            "auth"
+          ]
+        },
+        "spec": {
+          "type": "string",
+          "description": "The OpenAPI document, relative to the input root. Left out, the extractor walks the tree for every document and reads what sits beside each: a server generated from it means this service implements it, a client generated from it means this service calls it, and a called document names a system outside the estate unless peers says the api is one of ours.",
+          "examples": [
+            "internal/infrastructure/transport/http/gen/openapi.yaml"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which called documents are ours, as the api id to the service that implements it. A called document whose api is named here is that service's to describe, and is skipped rather than read as a system outside the estate.",
+          "examples": [
+            {
+              "auth.v1": "auth.auth"
+            }
+          ]
+        },
+        "externals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "What a called document's system is called when the name its title would give is not the one wanted, as the api id to the external's bare id. Left out, a document titled \"Stripe API\" makes the external stripe.",
+          "examples": [
+            {
+              "stripe.v1": "stripe"
+            }
+          ]
+        },
+        "api": {
+          "type": "string",
+          "description": "Prefix for the ids of the rpc services this produces. Left out, it is the document's own x-portolan-api when it carries one, and otherwise built from its title and major version: auth 1.0.0 gives auth.v1, and a tag called users gives auth.v1.Users.",
+          "examples": [
+            "auth.v1"
+          ]
+        },
+        "external": {
+          "type": "string",
+          "description": "Id of a system outside the estate the document belongs to, when it is not one of ours: a copy vendored beside the adapter that calls it, read for what the third party answers on. A bare name with no dot, the same one the caller's extractor is given under externals. Set, the fragment carries the external and no service, and context and service are not read.",
+          "examples": [
+            "stripe"
+          ]
+        },
+        "externalName": {
+          "type": "string",
+          "description": "What the external is called on the page.",
+          "examples": [
+            "Stripe"
+          ]
+        },
+        "externalSummary": {
+          "type": "string",
+          "description": "A sentence or two on what the estate uses it for."
+        },
+        "externalUrl": {
+          "type": "string",
+          "description": "Where the third party documents itself, for a reader who needs more than the vendored copy.",
+          "examples": [
+            "https://docs.stripe.com/api"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "api.json"
+        }
+      }
+    },
+    "options.wsdl": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Top-level group that owns the component implementing the WSDL contract.",
+          "examples": [
+            "booking"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Component implementing the WSDL contract.",
+          "examples": [
+            "gateway"
+          ]
+        },
+        "spec": {
+          "type": "string",
+          "description": "Root WSDL document relative to the input. Its local WSDL and XSD imports are followed. Left out, every WSDL in the tree is discovered.",
+          "examples": [
+            "contracts/booking.wsdl"
+          ]
+        },
+        "api": {
+          "type": "string",
+          "description": "API id prefix for a single contract. Defaults to the WSDL service name plus .soap.",
+          "examples": [
+            "booking.soap"
+          ]
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "service",
+            "external"
+          ],
+          "default": "service",
+          "description": "Whether the contract is implemented by this component or is a local copy used to call external systems."
+        },
+        "external": {
+          "type": "string",
+          "description": "One external id for all discovered contracts. In external mode, each WSDL service otherwise derives its own external id."
+        },
+        "externals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "External id overrides keyed by derived API id.",
+          "examples": [
+            {
+              "booking-service.soap": "booking-provider"
+            }
+          ]
+        },
+        "externalName": {
+          "type": "string",
+          "description": "Display name when external names one combined system."
+        },
+        "externalSummary": {
+          "type": "string",
+          "description": "Description when external names one combined system."
+        },
+        "externalUrl": {
+          "type": "string",
+          "description": "Documentation URL when it differs from the SOAP endpoint."
+        },
+        "out": {
+          "type": "string",
+          "description": "Fragment file name inside the step output directory.",
+          "default": "wsdl.json"
+        }
+      }
+    },
+    "options.http-clients": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the top-level group that owns the component. Defaults to the input directory name.",
+          "examples": [
+            "avia"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the component making outbound calls. Defaults to the input directory name.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Internal service answering an API, as API id to service id.",
+          "examples": [
+            {
+              "auth.v1": "auth.auth"
+            }
+          ]
+        },
+        "externals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Override for the external system named by a vendored client contract, as API id to external id.",
+          "examples": [
+            {
+              "gordian.v2": "gordian"
+            }
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file inside the step output directory.",
+          "default": "http-clients.json"
+        }
+      }
+    },
+    "options.redis": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the top-level group that owns the component. Defaults to the input directory name.",
+          "examples": [
+            "avia"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the component that constructs the Redis client. Defaults to the input directory name.",
+          "examples": [
+            "aviasupp"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the Redis store beneath the component.",
+          "default": "redis"
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable store name. Defaults to '<service> Redis'."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file inside the step output directory.",
+          "default": "redis.json"
+        }
+      }
+    },
+    "options.river": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the top-level group that owns the component. Defaults to the input directory name.",
+          "examples": [
+            "avia"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the component that inserts or handles River jobs. Defaults to the input directory name.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file inside the step output directory.",
+          "default": "river.json"
+        }
+      }
+    },
+    "options.watermill": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the top-level group that owns the component. Defaults to the input directory name.",
+          "examples": [
+            "avia"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the component that registers Watermill handlers or publishes messages. Defaults to the input directory name.",
+          "examples": [
+            "billing"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file inside the step output directory.",
+          "default": "watermill.json"
+        }
+      }
+    },
+    "options.go-nats": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context this service belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service. Defaults to the name of the input directory.",
+          "examples": [
+            "pricing"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "nats.json"
+        }
+      }
+    },
+    "options.asyncapi": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context that owns the service this document belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service the document describes. Defaults to the name of the input directory.",
+          "examples": [
+            "cart"
+          ]
+        },
+        "spec": {
+          "type": "string",
+          "description": "The AsyncAPI document, relative to the input root. Left out, the extractor looks for one.",
+          "examples": [
+            "src/infrastructure/bus/gen/asyncapi.yaml"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "bus.json"
+        }
+      }
+    },
+    "options.graphql": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context that owns the service this schema belongs to. Defaults to the name of the input directory.",
+          "examples": [
+            "storefront"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service the schema describes. Defaults to the name of the input directory.",
+          "examples": [
+            "bff"
+          ]
+        },
+        "schema": {
+          "type": "string",
+          "description": "The schema, relative to the input root: one .graphql document, or a directory of them read together. Left out, the extractor looks for them.",
+          "examples": [
+            "src/schema"
+          ]
+        },
+        "api": {
+          "type": "string",
+          "description": "Prefix for the ids of the interfaces this produces. Left out, it is the service and a major version: bff gives bff.v1, and a module called basket gives bff.v1.Basket.",
+          "examples": [
+            "storefront.v1"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "graphql.json"
+        }
+      }
+    },
+    "options.sql": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context that owns the service these migrations belong to. Defaults to the name of the input directory.",
+          "examples": [
+            "auth"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service that owns the database. A store belongs to exactly one service. Defaults to the name of the input directory.",
+          "examples": [
+            "auth"
+          ]
+        },
+        "store": {
+          "type": "string",
+          "description": "Slug of the database these migrations build. One service can keep state in more than one, and a slug is how the two are told apart. Give the go-domain extractor the same one.",
+          "default": "pg"
+        },
+        "name": {
+          "type": "string",
+          "description": "What the database is called on the page.",
+          "examples": [
+            "Auth database"
+          ]
+        },
+        "kind": {
+          "enum": [
+            "postgres",
+            "mysql",
+            "sqlite",
+            "redis",
+            "mongodb",
+            "clickhouse",
+            "s3",
+            "other"
+          ],
+          "description": "What kind of store it is.",
+          "default": "postgres"
+        },
+        "repositories": {
+          "type": "string",
+          "description": "Optional adapter root relative to the input root: either one package per aggregate with migrations below each package, or one feature repository package with migrations directly below it. When omitted, Go layouts are discovered under both internal/infrastructure/repository/<aggregate> and internal/<aggregate>/infrastructure/repository. The migrations and repository writes determine which aggregate and fields the tables persist."
+        },
+        "projectors": {
+          "type": "string",
+          "description": "Optional projector root relative to the input root, using the same collection-or-feature-package convention as repositories. When omitted, horizontal and feature-sliced Go projector packages are discovered. Every table created there gets the role projection. Its aggregate is read from a `-- aggregate: <id>` line above CREATE TABLE; columns copied from elsewhere carry `-- from:`."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "stores.json"
+        }
+      }
+    },
+    "options.markdown": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Heading of the index page. The catalog does not name the estate, so this is the one thing the generator cannot derive.",
+          "examples": [
+            "Example estate"
+          ]
+        },
+        "sourceBaseUrl": {
+          "type": "string",
+          "description": "Stable forge tree URL used to link source locations, for example https://github.com/acme/shop/blob/main. External repositories use their immutable catalog pins.",
+          "examples": [
+            "https://github.com/acme/shop/blob/main"
+          ]
+        }
+      }
+    },
+    "options.mermaid": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Heading of the Mermaid bundle index."
+        }
+      }
+    },
+    "options.backstage": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "domain": {
+          "type": "string",
+          "description": "Backstage metadata.name for the domain containing the exported systems.",
+          "default": "architecture"
+        },
+        "domainTitle": {
+          "type": "string",
+          "description": "Human-readable title of the Backstage domain.",
+          "default": "Architecture"
+        },
+        "owner": {
+          "type": "string",
+          "description": "Fallback Backstage owner for entities without a CODEOWNERS handle.",
+          "default": "architecture"
+        },
+        "lifecycle": {
+          "type": "string",
+          "description": "Lifecycle written on Backstage Components and APIs.",
+          "default": "production"
+        },
+        "sourceBaseUrl": {
+          "type": "string",
+          "description": "Stable forge tree URL used for Backstage source-location annotations."
+        }
+      }
+    },
+    "options.otel": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "traces"
+      ],
+      "properties": {
+        "traces": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string"
+          },
+          "description": "The recordings to read, as globs relative to the input root. OTLP JSON, one batch per file or one per line.",
+          "examples": [
+            [
+              "telemetry/traces.jsonl"
+            ]
+          ]
+        },
+        "services": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which catalog service a resource's service.name belongs to, for an estate where the two differ. Without a line here a name is matched to the one service whose slug it is.",
+          "examples": [
+            {
+              "auth-api": "auth.auth"
+            }
+          ]
+        },
+        "events": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which catalog event a wire name belongs to, for an estate where the event does not declare its wire name and the last segment of the event.name attribute is not the event's name in the model.",
+          "examples": [
+            {
+              "auth.PasswordChanged": "auth.auth.PasswordChanged"
+            }
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory."
+        }
+      }
+    },
+    "options.codeowners": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "file": {
+          "type": "string",
+          "description": "The CODEOWNERS to read, relative to the input root. Left out, the three places a forge looks, in order: CODEOWNERS, .github/CODEOWNERS, docs/CODEOWNERS. Its patterns are matched against each service's path as the catalog holds it, so they are repository-relative wherever the file itself sits.",
+          "examples": [
+            "CODEOWNERS",
+            ".github/CODEOWNERS"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. Left out, owners.json."
+        }
+      }
+    },
+    "options.adr": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The record files to read, as globs relative to the input root. A README.md among them is an index rather than a record and is skipped. Left out, every docs/adr/*.md.",
+          "examples": [
+            [
+              "docs/adr/*.md"
+            ],
+            [
+              "adr/*.md"
+            ]
+          ]
+        },
+        "scope": {
+          "type": "string",
+          "description": "What a record is about when it does not say so itself: \"org\", a context slug, or \"<context>.<service>\". A record written by adr-tools has no scope of its own and takes its id's prefix from here; a MADR record with a Scope bullet keeps its own.",
+          "examples": [
+            "avia.aviasupp",
+            "payments",
+            "org"
+          ]
+        },
+        "history": {
+          "enum": [
+            "git",
+            "none"
+          ],
+          "description": "Where a record's author and dates come from. \"git\", the default, reads the file's commits: who first added it and who last touched it. \"none\" reads nothing, for a tree that is not a checkout or a fragment that must not change when the history does.",
+          "default": "git"
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. Left out, adr.json."
+        }
+      }
+    },
+    "options.glossary": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context whose vocabulary this is. A glossary sits beside a service, and the words in it belong to the context that service is in, so shop/oms/GLOSSARY.md is read as shop. Left out, the name of the input directory.",
+          "examples": [
+            "auth",
+            "shop"
+          ]
+        },
+        "files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The glossaries to read, as globs relative to the input root. Left out, GLOSSARY.md at the root of it.",
+          "examples": [
+            [
+              "GLOSSARY.md"
+            ],
+            [
+              "docs/GLOSSARY.md"
+            ]
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. Left out, glossary.json."
+        }
+      }
+    },
+    "options.flows": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The flow files to read, as globs relative to the input root. Left out, every *.flow.md directly under the root.",
+          "examples": [
+            [
+              "*.flow.md"
+            ]
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory. Left out, flows.json."
+        }
+      }
+    },
+    "options.bsr": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "modules",
+        "cache"
+      ],
+      "properties": {
+        "modules": {
+          "type": "array",
+          "minItems": 1,
+          "description": "The modules to fetch, each pinned to a commit.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "module"
+            ],
+            "properties": {
+              "module": {
+                "type": "string",
+                "description": "The module's registry-global name: registry, owner and name.",
+                "examples": [
+                  "buf.build/shortlink-org/portolan-shop-order"
+                ]
+              },
+              "commit": {
+                "type": "string",
+                "description": "The commit to fetch. A BSR commit is immutable, so a pinned fetch is byte-reproducible, which is what lets an offline run replay it from the tree. Left out, `ref` is resolved online and warned about, and refused offline."
+              },
+              "ref": {
+                "type": "string",
+                "description": "The label to resolve when there is no commit. Defaults to main."
+              },
+              "paths": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Directories of the module to keep, relative to its root; the rest is left behind. Left out, the whole module.",
+                "examples": [
+                  [
+                    "shop/v1"
+                  ]
+                ]
+              }
+            }
+          }
+        },
+        "cache": {
+          "type": "string",
+          "description": "Where the last run's files were written, repo-relative: the same path as the step's out. An offline run replays what is there and checks it against the lock beside it."
+        }
+      }
+    },
+    "options.git": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "repos",
+        "cache"
+      ],
+      "properties": {
+        "repos": {
+          "type": "array",
+          "minItems": 1,
+          "description": "The repositories to fetch, each pinned to a commit.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "repo"
+            ],
+            "properties": {
+              "repo": {
+                "type": "string",
+                "description": "Where the repository is: github.com/acme/shop, or any URL git accepts (https://, ssh://, git@host:owner/name).",
+                "examples": [
+                  "github.com/acme/shop"
+                ]
+              },
+              "commit": {
+                "type": "string",
+                "description": "The commit to fetch. A pinned fetch is byte-reproducible, which is what lets an offline run replay it from the tree. Left out, `ref` is resolved online and warned about, and refused offline."
+              },
+              "ref": {
+                "type": "string",
+                "description": "The branch or tag to resolve when there is no commit. Defaults to the remote's HEAD."
+              },
+              "paths": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Directories to copy, relative to the repository's root; the rest is left behind. Left out, the whole tree.",
+                "examples": [
+                  [
+                    "services/oms",
+                    "proto"
+                  ]
+                ]
+              }
+            }
+          }
+        },
+        "cache": {
+          "type": "string",
+          "description": "Where the last run's files were written, repo-relative: the same path as the step's out. An offline run replays what is there and checks it against the lock beside it."
+        }
+      }
+    },
+    "options.proto": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "context",
+        "service"
+      ],
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context the service belongs to. A .proto knows its package, not which context owns it.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service that publishes or calls these protos.",
+          "examples": [
+            "oms"
+          ]
+        },
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Directories of protos this service publishes, relative to the input root. They become what it provides. A directory fetch-bsr wrote carries its lock, and the lock says which module the protos came from.",
+          "examples": [
+            [
+              "vendor/proto/shortlink-org/portolan-shop-order"
+            ]
+          ]
+        },
+        "vendored": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Directories of client copies this service consumes, relative to the input root. They become what it calls. Listed rather than globbed: which copies a service may keep is a boundary a reviewer should see change.",
+          "examples": [
+            [
+              "src/infrastructure/payments/proto"
+            ]
+          ]
+        },
+        "peers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which service answers for a vendored copy, as the proto package to its service id. A package with no line here is called as unknown and its steps stay unresolved.",
+          "examples": [
+            {
+              "payments.v1": "payments.ledger"
+            }
+          ]
+        },
+        "modules": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Which module a directory's protos belong to, as the directory relative to the input root to the module id. Only needed where there is no lock beside them to say.",
+          "examples": [
+            {
+              "src/infrastructure/payments/proto": "buf.build/shortlink-org/portolan-payments-payment"
+            }
+          ]
+        },
+        "defs": {
+          "enum": [
+            "shared",
+            "off"
+          ],
+          "description": "Whether a message imported from another file is promoted to a shared type, on the reasoning that the import is the author's own signal it is not local.",
+          "default": "shared"
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "proto.json"
+        }
+      }
+    }
+  }
+}