@shortlink-org/portolan 0.3.0 → 0.4.0

package/schema/portolan.schema.json

@@ -52,6 +52,14 @@
       },
       "description": "CEL policies for reviewed extraction limitations. Expressions are type-checked when the manifest is read and suppression always requires a reason."
     },
+    "problemRules": {
+      "type": "array",
+      "maxItems": 200,
+      "items": {
+        "$ref": "#/$defs/problemRule"
+      },
+      "description": "The rules the Problems page applies. An entry naming a built-in rule (rules/builtin.json) switches it off or re-grades it, with a reason; any other id is a rule of its own, written in CEL over one subject. Expressions are type-checked when the manifest is read and run in the page over the merged catalog."
+    },
     "plugins": {
       "type": "array",
       "items": {
@@ -77,6 +85,9 @@
               "go-domain",
               "ts-domain",
               "rust-domain",
+              "laravel-domain",
+              "php-ddd",
+              "csharp-ddd",
               "java-domain",
               "django-domain",
               "celery",
@@ -88,6 +99,10 @@
               "river",
               "watermill",
               "go-nats",
+              "go-sqs",
+              "terraform",
+              "k8s",
+              "argocd-gitops",
               "asyncapi",
               "graphql",
               "sql",
@@ -97,6 +112,8 @@
               "bsr",
               "git",
               "csr",
+              "k8s-cluster",
+              "argocd",
               "csr-schemas",
               "proto"
             ],
@@ -211,6 +228,63 @@
               }
             }
           },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "laravel-domain"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.laravel-domain"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "php-ddd"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.php-ddd"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "csharp-ddd"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.csharp-ddd"
+                }
+              }
+            }
+          },
           {
             "if": {
               "required": [
@@ -420,6 +494,82 @@
               }
             }
           },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "go-sqs"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.go-sqs"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "terraform"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.terraform"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "k8s"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.k8s"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "argocd-gitops"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.argocd-gitops"
+                }
+              }
+            }
+          },
           {
             "if": {
               "required": [
@@ -591,6 +741,44 @@
               }
             }
           },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "k8s-cluster"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.k8s-cluster"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "argocd"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.argocd"
+                }
+              }
+            }
+          },
           {
             "if": {
               "required": [
@@ -803,6 +991,170 @@
     }
   },
   "$defs": {
+    "problemRule": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z0-9]+(?:[-.][a-z0-9]+)*$",
+          "description": "The rule. One of the built-in ids - rpc, consumer, cross-service-fk, cross-service-lineage, cross-service-view, shared-store, persistence-drift, column-type, outbox-payload, proto-missing, proto-drift, shared-channel, channel-undeclared, channel-unpublished, message-encoding, subscription-unresolved, deployment-unclaimed, deployment-drift - to switch or re-grade that rule; any other id declares a rule of its own."
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether the rule produces rows. A disabled rule needs a reason and stays listed on the Settings page."
+        },
+        "severity": {
+          "enum": [
+            "error",
+            "warning"
+          ],
+          "description": "How wrong a row of this rule is. For a built-in rule this replaces the severity its passport was written with."
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Why the rule is off or re-graded, or, for a rule of your own, why the estate holds it."
+        },
+        "over": {
+          "enum": [
+            "service",
+            "call",
+            "copy",
+            "event",
+            "consumer",
+            "channel",
+            "subscription",
+            "table",
+            "column",
+            "deployment",
+            "flow",
+            "aggregate"
+          ],
+          "description": "What one row of the rule is about, and what `when` and `message` read."
+        },
+        "when": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000,
+          "description": "The condition: a row exists for every subject where it holds. CEL returning bool, over the subject named by `over` and `estate` (services, contexts, stores, channels, externals). Fields by subject: service: id, slug, name, context, kind, repo, path, technologies, owners, provides, methods, calls, unresolvedCalls, aggregates, events, stores, channels, hosts, dials; call: id, interface, method, peer, status, resolved, peerKnown, methodDeclared, service, context, source, module, note; copy: id, service, context, provider, methods, differences, source; event: id, slug, name, aggregate, service, context, versions, deprecated, consumers, unresolvedConsumers, wireName, channel, declaredChannels, fields; consumer: event, name, aggregate, owner, context, consumer, status, resolved, note; channel: address, kind, title, service, context, declared, publishes, sends, receives, events, otherPublishers, otherClaims, source; subscription: service, context, channel, kind, name, encoding, published, publishers, mismatched, mismatchedEncodings, source; table: id, name, kind, store, storeKind, owner, context, role, aggregate, aggregateOwner, aggregateFields, mappedColumns, claimedColumns, block, columns, primaryKey, foreignKeys, foreignReads, hasPayload, indexes, reads, writes, deletes; column: id, name, relation, kind, store, owner, context, type, nullable, pk, fk, fkOwner, from, foreignFrom, foreignOwners, maps, fieldType, typeMatches; deployment: id, name, project, environment, cluster, namespace, repo, path, chart, from, targetRevision, revision, tool, service, labelled, claimed, context, runsIn, images, basis, drifted, drift, url; flow: id, slug, name, owner, trigger, triggerConfidence, participants, contexts, crossContext, steps, verifiedSteps, declaredSteps, unresolvedSteps, seenSteps, events, stores, examples, source; aggregate: id, slug, name, root, modelGroup, service, context, entities, valueObjects, enums, commands, queries, exposedOperations, deprecatedOperations, events, states, transitions, tables."
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000,
+          "description": "The note on the row. CEL returning string, over the subject named by `over` and `estate` (services, contexts, stores, channels, externals). Fields by subject: service: id, slug, name, context, kind, repo, path, technologies, owners, provides, methods, calls, unresolvedCalls, aggregates, events, stores, channels, hosts, dials; call: id, interface, method, peer, status, resolved, peerKnown, methodDeclared, service, context, source, module, note; copy: id, service, context, provider, methods, differences, source; event: id, slug, name, aggregate, service, context, versions, deprecated, consumers, unresolvedConsumers, wireName, channel, declaredChannels, fields; consumer: event, name, aggregate, owner, context, consumer, status, resolved, note; channel: address, kind, title, service, context, declared, publishes, sends, receives, events, otherPublishers, otherClaims, source; subscription: service, context, channel, kind, name, encoding, published, publishers, mismatched, mismatchedEncodings, source; table: id, name, kind, store, storeKind, owner, context, role, aggregate, aggregateOwner, aggregateFields, mappedColumns, claimedColumns, block, columns, primaryKey, foreignKeys, foreignReads, hasPayload, indexes, reads, writes, deletes; column: id, name, relation, kind, store, owner, context, type, nullable, pk, fk, fkOwner, from, foreignFrom, foreignOwners, maps, fieldType, typeMatches; deployment: id, name, project, environment, cluster, namespace, repo, path, chart, from, targetRevision, revision, tool, service, labelled, claimed, context, runsIn, images, basis, drifted, drift, url; flow: id, slug, name, owner, trigger, triggerConfidence, participants, contexts, crossContext, steps, verifiedSteps, declaredSteps, unresolvedSteps, seenSteps, events, stores, examples, source; aggregate: id, slug, name, root, modelGroup, service, context, entities, valueObjects, enums, commands, queries, exposedOperations, deprecatedOperations, events, states, transitions, tables."
+        },
+        "peer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000,
+          "description": "The row's far end, when it has one; a service, event or table id links to its page. CEL returning string, over the subject named by `over` and `estate` (services, contexts, stores, channels, externals). Fields by subject: service: id, slug, name, context, kind, repo, path, technologies, owners, provides, methods, calls, unresolvedCalls, aggregates, events, stores, channels, hosts, dials; call: id, interface, method, peer, status, resolved, peerKnown, methodDeclared, service, context, source, module, note; copy: id, service, context, provider, methods, differences, source; event: id, slug, name, aggregate, service, context, versions, deprecated, consumers, unresolvedConsumers, wireName, channel, declaredChannels, fields; consumer: event, name, aggregate, owner, context, consumer, status, resolved, note; channel: address, kind, title, service, context, declared, publishes, sends, receives, events, otherPublishers, otherClaims, source; subscription: service, context, channel, kind, name, encoding, published, publishers, mismatched, mismatchedEncodings, source; table: id, name, kind, store, storeKind, owner, context, role, aggregate, aggregateOwner, aggregateFields, mappedColumns, claimedColumns, block, columns, primaryKey, foreignKeys, foreignReads, hasPayload, indexes, reads, writes, deletes; column: id, name, relation, kind, store, owner, context, type, nullable, pk, fk, fkOwner, from, foreignFrom, foreignOwners, maps, fieldType, typeMatches; deployment: id, name, project, environment, cluster, namespace, repo, path, chart, from, targetRevision, revision, tool, service, labelled, claimed, context, runsIn, images, basis, drifted, drift, url; flow: id, slug, name, owner, trigger, triggerConfidence, participants, contexts, crossContext, steps, verifiedSteps, declaredSteps, unresolvedSteps, seenSteps, events, stores, examples, source; aggregate: id, slug, name, root, modelGroup, service, context, entities, valueObjects, enums, commands, queries, exposedOperations, deprecatedOperations, events, states, transitions, tables."
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The rule's name on the Settings page."
+        },
+        "note": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The short words on every row of the rule; the title when absent."
+        },
+        "description": {
+          "type": "string",
+          "description": "What the rule checks and why it matters."
+        },
+        "action": {
+          "type": "string",
+          "description": "What a reader does about a row."
+        }
+      },
+      "if": {
+        "properties": {
+          "id": {
+            "enum": [
+              "rpc",
+              "consumer",
+              "cross-service-fk",
+              "cross-service-lineage",
+              "cross-service-view",
+              "shared-store",
+              "persistence-drift",
+              "column-type",
+              "outbox-payload",
+              "proto-missing",
+              "proto-drift",
+              "shared-channel",
+              "channel-undeclared",
+              "channel-unpublished",
+              "message-encoding",
+              "subscription-unresolved",
+              "deployment-unclaimed",
+              "deployment-drift"
+            ]
+          }
+        }
+      },
+      "then": {
+        "not": {
+          "anyOf": [
+            {
+              "required": [
+                "over"
+              ]
+            },
+            {
+              "required": [
+                "when"
+              ]
+            },
+            {
+              "required": [
+                "message"
+              ]
+            },
+            {
+              "required": [
+                "peer"
+              ]
+            },
+            {
+              "required": [
+                "title"
+              ]
+            },
+            {
+              "required": [
+                "note"
+              ]
+            },
+            {
+              "required": [
+                "description"
+              ]
+            },
+            {
+              "required": [
+                "action"
+              ]
+            }
+          ]
+        }
+      },
+      "else": {
+        "required": [
+          "over",
+          "when",
+          "message",
+          "title"
+        ]
+      }
+    },
     "warningPolicy": {
       "type": "object",
       "additionalProperties": false,
@@ -995,7 +1347,9 @@
           "enum": [
             "fetch-git",
             "fetch-bsr",
-            "fetch-csr"
+            "fetch-csr",
+            "fetch-k8s",
+            "fetch-argocd"
           ],
           "description": "A plugin the host runs inside its own process, because it needs a socket or a git binary (portolan.0008). Only the ones shipped with Portolan can be named."
         },
@@ -1473,24 +1827,27 @@
         }
       }
     },
-    "options.java-domain": {
+    "options.laravel-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.",
+          "description": "Slug of the bounded context this application belongs to. A composer.json knows its name, not which context owns it. Defaults to the name of the input directory.",
           "examples": [
-            "payments"
+            "shop"
           ]
         },
         "contextName": {
           "type": "string",
-          "description": "What the context is called on the page. Defaults to the slug, titled."
+          "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."
+          "description": "A sentence or two on what the context is responsible for. Read on the context page and nowhere else."
         },
         "classification": {
           "enum": [
@@ -1504,7 +1861,7 @@
           "type": "string",
           "description": "Slug of the service. Defaults to the name of the input directory.",
           "examples": [
-            "ledger"
+            "bagisto"
           ]
         },
         "serviceName": {
@@ -1513,19 +1870,234 @@
         },
         "repo": {
           "type": "string",
-          "description": "Where the source lives. Defaults to the scm url in pom.xml.",
+          "description": "Where the source lives. Defaults to composer.json's support.source or homepage when either names a repository.",
           "examples": [
-            "github.com/shortlink-org/portolan"
+            "github.com/bagisto/bagisto"
           ]
         },
-        "store": {
+        "modules": {
           "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.",
+          "description": "Where the application's modules are, as a directory pattern relative to the input root with `*` for one path segment: `packages/*/*/src` for a package-per-module monolith, `app` for a plain Laravel application. Each match is one module, named after the directory the pattern's last literal segment sits in. Defaults to `packages/*/*/src` when that matches anything, and to `app` otherwise.",
           "examples": [
-            "pg"
+            "packages/*/*/src",
+            "app",
+            "modules/*"
           ]
         },
-        "peers": {
+        "store": {
+          "type": "string",
+          "description": "Slug of the database the migrations describe and the models read and write. The store's id is the service id and this slug.",
+          "default": "db",
+          "examples": [
+            "mysql"
+          ]
+        },
+        "storeKind": {
+          "enum": [
+            "postgres",
+            "mysql",
+            "sqlite",
+            "other"
+          ],
+          "description": "Which database the migrations are the schema of. Read off config/database.php's default connection when left out - `env('DB_CONNECTION', 'mysql')` names it - and mysql when that cannot be read; given here, it wins."
+        },
+        "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"
+        },
+        "storesOut": {
+          "type": "string",
+          "description": "Name of the store fragment, inside the step's output directory. Written when the migrations declare tables or the code reaches any.",
+          "default": "stores.json"
+        },
+        "openapiOut": {
+          "type": "string",
+          "description": "Name of the inferred OpenAPI 3.1 document, inside the step's output directory. Written when the route files expose HTTP operations.",
+          "default": "openapi.inferred.yaml"
+        }
+      }
+    },
+    "options.php-ddd": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "source": {
+          "type": "string",
+          "description": "The directory the bounded contexts are in, relative to the input root: one directory per context, one per module under it, `Domain`, `Application` and `Infrastructure` under that. A `Shared` directory at either level is the shared kernel and is not a context or a module.",
+          "default": "src"
+        },
+        "apps": {
+          "type": "string",
+          "description": "The directory the deployable applications are in, relative to the input root: `<apps>/<context>/<app>`, each with `config/routes/*.yaml` and `src/Controller/`. Each application is a service of its context; a context with none gets one service named after itself.",
+          "default": "apps"
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives. Defaults to composer.json's support.source or homepage when either names a repository.",
+          "examples": [
+            "github.com/CodelyTV/php-ddd-example"
+          ]
+        },
+        "exchange": {
+          "type": "string",
+          "description": "The RabbitMQ exchange domain events are published to. The code reads it from the environment, so the manifest says.",
+          "default": "domain_events"
+        },
+        "storeKind": {
+          "enum": [
+            "postgres",
+            "mysql",
+            "sqlite",
+            "other"
+          ],
+          "description": "What the Doctrine-mapped tables live in.",
+          "default": "mysql"
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the contexts are core to the business, support it, or are generic and could be bought. One value for every context the tree declares."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "domain.json"
+        },
+        "openapiOut": {
+          "type": "string",
+          "description": "Name of the inferred OpenAPI 3.1 document, inside the step's output directory. Written when the route files expose HTTP operations.",
+          "default": "openapi.inferred.yaml"
+        },
+        "storesOut": {
+          "type": "string",
+          "description": "Name of the store fragment, inside the step's output directory. Written when a Doctrine mapping or a repository adapter names a store.",
+          "default": "stores.json"
+        }
+      }
+    },
+    "options.csharp-ddd": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "modules": {
+          "type": "string",
+          "description": "The directory the modules are in, relative to the input root: one directory per module, `Domain`, `Application`, `Infrastructure` and `IntegrationEvents` under it. Each module is a bounded context with one service.",
+          "default": "src/Modules"
+        },
+        "api": {
+          "type": "string",
+          "description": "The directory the HTTP host is in, relative to the input root. Controllers under a `Modules/<Module>` directory beneath it are that module's HTTP edge.",
+          "default": "src/API"
+        },
+        "database": {
+          "type": "string",
+          "description": "The directory the database project is in, relative to the input root: `Structure/<schema>/Tables/*.sql` and `Structure/<schema>/Views/*.sql` beneath it, one schema per module.",
+          "default": "src/Database"
+        },
+        "repo": {
+          "type": "string",
+          "description": "Where the source lives, as `host/owner/name`. Nothing in a .NET tree says, so the manifest does.",
+          "examples": [
+            "github.com/kgrzybek/modular-monolith-with-ddd"
+          ]
+        },
+        "bus": {
+          "type": "string",
+          "description": "The address of the bus integration events cross modules on. The code names the class, `InMemoryEventBus`, and nothing else, so the manifest says.",
+          "default": "integration-events"
+        },
+        "storeKind": {
+          "enum": [
+            "postgres",
+            "mysql",
+            "sqlite",
+            "other"
+          ],
+          "description": "What the schemas live in. SQL Server is `other`.",
+          "default": "other"
+        },
+        "classification": {
+          "enum": [
+            "core",
+            "supporting",
+            "generic"
+          ],
+          "description": "Whether the modules are core to the business, support it, or are generic and could be bought. One value for every module the tree declares."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "domain.json"
+        },
+        "openapiOut": {
+          "type": "string",
+          "description": "Name of the inferred OpenAPI 3.1 document, inside the step's output directory, one per module with controllers; `{service}` is replaced with the module's slug.",
+          "default": "openapi.{service}.yaml"
+        },
+        "storesOut": {
+          "type": "string",
+          "description": "Name of the store fragment, inside the step's output directory. Written when the database project declares a schema a module maps to.",
+          "default": "stores.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"
@@ -2151,6 +2723,160 @@
         }
       }
     },
+    "options.go-sqs": {
+      "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": [
+            "fulfillment"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "sqs.json"
+        }
+      }
+    },
+    "options.terraform": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context the module deploys into. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service the module sits beside. Queues, topics and stores nothing in the module claims are listed on it, and it owns every store. A Lambda function whose name slugs to this becomes the service itself; any other becomes a component of kind function in the same context. Defaults to the name of the input directory.",
+          "examples": [
+            "fulfillment"
+          ]
+        },
+        "dir": {
+          "type": "string",
+          "description": "Directory of *.tf files to read, relative to the input root. Left out, the root is read when it holds *.tf files, and otherwise the one directory under it that does - when there are several, the first by name, and the rest are named in a warning. Local modules (source = ./...) are followed from wherever they are called; registry modules are not read.",
+          "examples": [
+            "deploy/terraform"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "terraform.json"
+        }
+      }
+    },
+    "options.k8s": {
+      "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. The workload is found by this name: a Deployment, StatefulSet, DaemonSet, Job or CronJob called so, or labelled so with `app` or `app.kubernetes.io/name`; when the tree holds exactly one workload, that one.",
+          "examples": [
+            "pricing"
+          ]
+        },
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Directories under the input root that hold the manifests, so a repository's other YAML - compose files, CI, buf - is not walked. Left out, the whole root is read and anything without `apiVersion` and `kind` is passed over.",
+          "examples": [
+            [
+              "deploy/k8s"
+            ]
+          ]
+        },
+        "namespace": {
+          "type": "string",
+          "description": "Read only the objects in this namespace. An object that names no namespace is read either way. Left out, every namespace.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "k8s.json"
+        }
+      }
+    },
+    "options.argocd-gitops": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "repo": {
+          "type": "string",
+          "description": "The repository this tree is, spelled the way `Service.repo` spells it. A git generator pointing at another repository cannot be walked and is passed over with a warning; left out, every git generator is taken to mean this tree.",
+          "examples": [
+            "github.com/acme/gitops"
+          ]
+        },
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Directories under the input root that hold the Applications and ApplicationSets, so overlays and charts beside them are not read for Argo CD objects. Left out, the whole root is walked.",
+          "examples": [
+            [
+              "bootstrap",
+              "appsets"
+            ]
+          ]
+        },
+        "environmentLabel": {
+          "type": "string",
+          "default": "env",
+          "description": "The Application label that names the environment. An Application without it is placed by the cluster it deploys to."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Which Application labels name the service it deploys. The defaults are the Kubernetes recommended labels, the same ones fetch-argocd and fetch-k8s read.",
+          "properties": {
+            "context": {
+              "type": "string",
+              "description": "The label whose value is the bounded context's slug.",
+              "default": "app.kubernetes.io/part-of"
+            },
+            "service": {
+              "type": "string",
+              "description": "The label whose value is the service's slug.",
+              "default": "app.kubernetes.io/name"
+            }
+          }
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "argocd.json"
+        }
+      }
+    },
     "options.asyncapi": {
       "type": "object",
       "additionalProperties": false,
@@ -2385,6 +3111,14 @@
             }
           ]
         },
+        "examples": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many recordings a flow keeps as examples of itself running: the ones that show the most of it, earliest first. Five when unset; zero keeps none.",
+          "examples": [
+            3
+          ]
+        },
         "out": {
           "type": "string",
           "description": "Name of the fragment file, inside the step's output directory."
@@ -2674,6 +3408,139 @@
         }
       }
     },
+    "options.k8s-cluster": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "cache"
+      ],
+      "properties": {
+        "kubeContext": {
+          "type": "string",
+          "description": "The kubeconfig context to read, passed to kubectl as --context. Left out, kubectl's current context.",
+          "examples": [
+            "prod-eu"
+          ]
+        },
+        "namespaces": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The namespaces to read. Left out, every namespace the credential can list.",
+          "examples": [
+            [
+              "shop",
+              "auth",
+              "payments"
+            ]
+          ]
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Which labels place a workload into the catalog. The defaults are the Kubernetes recommended labels; an estate that labels differently names its own keys here.",
+          "properties": {
+            "context": {
+              "type": "string",
+              "description": "The label whose value is the bounded context's slug.",
+              "default": "app.kubernetes.io/part-of"
+            },
+            "service": {
+              "type": "string",
+              "description": "The label whose value is the service's slug. A workload without it is named after itself.",
+              "default": "app.kubernetes.io/name"
+            }
+          }
+        },
+        "namespaceContexts": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Namespace to bounded context, for workloads that carry no context label. A workload with the label keeps it; one with neither is counted in a warning and left out.",
+          "examples": [
+            {
+              "shop": "shop",
+              "shop-jobs": "shop"
+            }
+          ]
+        },
+        "cache": {
+          "type": "string",
+          "description": "Where the last run's fragment was written, repo-relative: the same path as the step's out. An offline run, or one that cannot reach the cluster, replays it unchanged."
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "k8s-cluster.json"
+        }
+      }
+    },
+    "options.argocd": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "server",
+        "cache"
+      ],
+      "properties": {
+        "server": {
+          "type": "string",
+          "description": "The Argo CD API server: a host, or a URL when it is not https. The token comes from ARGOCD_AUTH_TOKEN, never from here.",
+          "examples": [
+            "argocd.example.com"
+          ]
+        },
+        "projects": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Argo CD projects to read applications from. Left out, every application the token can list.",
+          "examples": [
+            [
+              "shop",
+              "platform"
+            ]
+          ]
+        },
+        "selector": {
+          "type": "string",
+          "description": "A label selector narrowing the applications, as `argocd app list -l` takes one.",
+          "examples": [
+            "team=shop"
+          ]
+        },
+        "environmentLabel": {
+          "type": "string",
+          "default": "env",
+          "description": "The application label that names the environment. An application without it is placed by the cluster it deploys to."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Which application labels name the service it deploys. The defaults are the Kubernetes recommended labels, the same ones fetch-k8s reads off a workload; an estate that labels differently names its own keys here. An application without them is placed by the repository and directory it deploys from.",
+          "properties": {
+            "context": {
+              "type": "string",
+              "description": "The label whose value is the bounded context's slug.",
+              "default": "app.kubernetes.io/part-of"
+            },
+            "service": {
+              "type": "string",
+              "description": "The label whose value is the service's slug.",
+              "default": "app.kubernetes.io/name"
+            }
+          }
+        },
+        "cache": {
+          "type": "string",
+          "description": "Where the last run's snapshot was 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.csr-schemas": {
       "type": "object",
       "additionalProperties": false,