@opensoftware/contracts 1.6.0 → 1.8.0

package/README.md

@@ -44,13 +44,16 @@ Each format has one schema, generated from `typespec/`, and fixtures that CONTRA
 | score | `score/score.schema.json` | `Score` | Subset of Langfuse's create-score request; factory fields in `metadata`. |
 | gate record | `gate-record/gate-record.schema.json` | `GateRecord` | gatekeeper's signed approval record (ADR 0047). |
 | sandbox spec | `sandbox-spec/sandbox-spec.schema.json` | `SandboxSpec` | The input of a sandbox adapter's `create` (ADR 0054). Closed objects: an unknown field is an error. |
-| events | `events/<event>/<event>.schema.json`, `events/asyncapi.yaml` | `WorkReceived` … `PrClosed` | CloudEvents 1.0, structured JSON. |
+| events | `events/<event>/<event>.schema.json`, `events/asyncapi.yaml` | `WorkReceived`, `RunStarted` … `IssueLabeled` | CloudEvents 1.0, structured JSON. |
 
 ## HTTP APIs
 
 `openapi/openapi.json` also holds the paths of the module APIs, from the operations in `typespec/` (ADR 0048). The
 first is gatekeeper's: `POST /v1/gates` and `GET /v1/gates/{gateId}` with the models `GateRequest`, `GateView` and
-`ApiProblem` (RFC 9457). `pnpm build` compiles the operations with the TypeSpec OpenAPI 3 emitter and copies their
+`ApiProblem` (RFC 9457). The second is intake's (ADR 0063): `POST /v1/work-items` and
+`GET /v1/work-items/{workItemId}` with the models `WorkSubmission`, `WorkItemView` and `WorkRequest`. The third is the
+foreman's (ADR 0067): `POST /v1/runs`, `GET /v1/runs/{runId}` and `POST /v1/runs/{runId}/signals` with the models
+`RunView`, `StageView`, `CheckView` (ADR 0069) and `RunSignal`. `pnpm build` compiles the operations with the TypeSpec OpenAPI 3 emitter and copies their
 paths next to the named models; an operation that uses a type that is no model fails the build. The package exports
 the type `paths`, which types a client such as openapi-fetch.
 

package/dist/formats.js

@@ -9,6 +9,7 @@ export const FORMATS = [
     format("gate-record", "GateRecord"),
     format("sandbox-spec", "SandboxSpec"),
     format("events/work-received", "WorkReceived"),
+    format("events/run-started", "RunStarted"),
     format("events/run-completed", "RunCompleted"),
     format("events/gate-requested", "GateRequested"),
     format("events/gate-decided", "GateDecided"),
@@ -16,6 +17,7 @@ export const FORMATS = [
     format("events/pr-opened", "PrOpened"),
     format("events/pr-reviewed", "PrReviewed"),
     format("events/pr-closed", "PrClosed"),
+    format("events/issue-labeled", "IssueLabeled"),
 ];
 export function formatNamed(name) {
     return FORMATS.find((candidate) => candidate.name === name);

package/dist/formats.js.map

@@ -1 +1 @@
-{"version":3,"file":"formats.js","sourceRoot":"","sources":["../src/formats.ts"],"names":[],"mappings":"AAAA,2GAA2G;AAW3G,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAEjH,MAAM,CAAC,MAAM,OAAO,GAAsB;IACxC,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,CAAC;IACjD,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC;IAC/B,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC;IACjC,MAAM,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;IAC7C,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC;IACnC,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC;IACrC,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC;IAC9C,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC;IAC9C,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC;IAChD,MAAM,CAAC,qBAAqB,EAAE,aAAa,CAAC;IAC5C,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC;IAChD,MAAM,CAAC,kBAAkB,EAAE,UAAU,CAAC;IACtC,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;IAC1C,MAAM,CAAC,kBAAkB,EAAE,UAAU,CAAC;CACvC,CAAC;AAEF,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC9D,CAAC"}
+{"version":3,"file":"formats.js","sourceRoot":"","sources":["../src/formats.ts"],"names":[],"mappings":"AAAA,2GAA2G;AAW3G,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAEjH,MAAM,CAAC,MAAM,OAAO,GAAsB;IACxC,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,CAAC;IACjD,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC;IAC/B,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC;IACjC,MAAM,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;IAC7C,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC;IACnC,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC;IACrC,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC;IAC9C,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;IAC1C,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC;IAC9C,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC;IAChD,MAAM,CAAC,qBAAqB,EAAE,aAAa,CAAC;IAC5C,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC;IAChD,MAAM,CAAC,kBAAkB,EAAE,UAAU,CAAC;IACtC,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;IAC1C,MAAM,CAAC,kBAAkB,EAAE,UAAU,CAAC;IACtC,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC;CAC/C,CAAC;AAEF,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC9D,CAAC"}

package/dist/generated/types.d.ts

@@ -33,6 +33,92 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
+    "/v1/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Start a run of the factory's workflow for a work item. The same work item again answers the run it started. */
+        post: operations["ForemanApi_startRun"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/runs/{runId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description A run: its state and the state of each stage. */
+        get: operations["ForemanApi_getRun"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/runs/{runId}/signals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Steer the running stage's agent, or cancel the run. */
+        post: operations["ForemanApi_signalRun"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/work-items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description The work item with this dedupe key, such as an issue's link (ADR 0065). */
+        get: operations["IntakeApi_findWorkItem"];
+        put?: never;
+        /** @description Put work into the inbox. A submission with the dedupe key of a work item answers that work item. */
+        post: operations["IntakeApi_submitWork"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/work-items/{workItemId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description A work item, its status and every request that asked for it. */
+        get: operations["IntakeApi_getWorkItem"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 };
 export type webhooks = Record<string, never>;
 export type components = {
@@ -107,6 +193,18 @@ export type components = {
         };
         /** @description A path inside the bundle: relative, forward slashes, no "..". */
         BundlePath: string;
+        /** @description The name of a check on the forge: a commit status context. */
+        CheckName: string;
+        /**
+         * @description foreman: the state of a check on the forge (forge port).
+         * @enum {string}
+         */
+        CheckState: "pending" | "success" | "failure" | "error";
+        /** @description foreman: a check that a stage waits for, as the foreman last read it on the run's pull request (ADR 0069). */
+        CheckView: {
+            name: components["schemas"]["CheckName"];
+            state: components["schemas"]["CheckState"];
+        };
         /** @description A Git commit hash, abbreviated (7+) or full. The factory version is the commit of the factory definition. */
         CommitHash: string;
         /**
@@ -332,6 +430,46 @@ export type components = {
         Hostname: string;
         /** @description An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque. */
         Identifier: string;
+        /** @description forge adapters: a label was added to an issue. */
+        IssueLabeled: {
+            /** @constant */
+            specversion: "1.0";
+            /** @description Unique per source. A consumer that sees the same source and id twice handles the event once. */
+            id: components["schemas"]["Identifier"];
+            /** @description The producing module, for example "/osf/intake". */
+            source: string;
+            /** @constant */
+            type: "issue.labeled@v1";
+            /** Format: date-time */
+            time: string;
+            /** @description The ID of the thing the event is about: work item, gate, run, score or pull request. */
+            subject?: string;
+            /** @constant */
+            datacontenttype?: "application/json";
+            /** Format: uri */
+            dataschema?: string;
+            /** @description W3C trace context (CloudEvents distributed tracing extension). */
+            traceparent?: string;
+            data: components["schemas"]["IssueLabeledData"];
+        };
+        IssueLabeledData: {
+            /**
+             * Format: uri
+             * @description The issue.
+             */
+            url: string;
+            /** Format: uri */
+            repository: string;
+            number: number;
+            title: string;
+            body?: string;
+            /** @description The person who opened the issue. */
+            author: components["schemas"]["Actor"];
+            /** @description Every label of the issue after the change. */
+            labels: string[];
+            /** @description The label that was added, when the forge names it. */
+            label?: string;
+        };
         Link: {
             /** Format: uri */
             url: string;
@@ -569,6 +707,17 @@ export type components = {
             "osf.harness.name": components["schemas"]["Name"];
             "osf.harness.version"?: string;
         };
+        /** @description foreman: a signal to a run: "steer" with a message for the running stage's agent, or "cancel". */
+        RunSignal: {
+            type: components["schemas"]["RunSignalType"];
+            /** @description The steering message. Required with "steer". */
+            message?: string;
+        };
+        /**
+         * @description foreman: what a person tells a run.
+         * @enum {string}
+         */
+        RunSignalType: "steer" | "cancel";
         /** @description Attributes of the root span of the run. GenAI names where a convention exists. */
         RunSpan: {
             /** @constant */
@@ -603,6 +752,68 @@ export type components = {
              */
             "osf.agent_trace.uri"?: string;
         };
+        /** @description foreman: a run started (ADR 0067). */
+        RunStarted: {
+            /** @constant */
+            specversion: "1.0";
+            /** @description Unique per source. A consumer that sees the same source and id twice handles the event once. */
+            id: components["schemas"]["Identifier"];
+            /** @description The producing module, for example "/osf/intake". */
+            source: string;
+            /** @constant */
+            type: "run.started@v1";
+            /** Format: date-time */
+            time: string;
+            /** @description The ID of the thing the event is about: work item, gate, run, score or pull request. */
+            subject?: string;
+            /** @constant */
+            datacontenttype?: "application/json";
+            /** Format: uri */
+            dataschema?: string;
+            /** @description W3C trace context (CloudEvents distributed tracing extension). */
+            traceparent?: string;
+            data: components["schemas"]["RunStartedData"];
+        };
+        RunStartedData: {
+            runId: components["schemas"]["Identifier"];
+            workItemId: components["schemas"]["Identifier"];
+            /** @description The name of the factory. */
+            factory: components["schemas"]["Name"];
+            factoryVersion: components["schemas"]["CommitHash"];
+            /** @description The stages of the run's workflow, in order. */
+            stages: components["schemas"]["Name"][];
+            /** Format: date-time */
+            startedAt: string;
+            requester: components["schemas"]["Actor"];
+            source: components["schemas"]["Name"];
+        };
+        /**
+         * @description foreman: where a run stands (vision scenario ORCH-008).
+         * @enum {string}
+         */
+        RunState: "running" | "blocked" | "complete" | "failed" | "cancelled";
+        /** @description foreman: a run of the factory's workflow for one work item, as the HTTP API shows it (ADR 0067). */
+        RunView: {
+            /** @description "run_" and 20 hex digits of the SHA-256 of the work item's ID. */
+            runId: string;
+            workItem: components["schemas"]["WorkItem"];
+            /** @description The name of the factory. */
+            factory: components["schemas"]["Name"];
+            /** @description The commit of the factory definition the run started with. */
+            factoryVersion: components["schemas"]["CommitHash"];
+            state: components["schemas"]["RunState"];
+            /**
+             * Format: uri
+             * @description The last pull request link that an agent of the run wrote (ADR 0069).
+             */
+            pullRequest?: string;
+            /** Format: date-time */
+            startedAt: string;
+            /** Format: date-time */
+            endedAt?: string;
+            /** @description The stages of the workflow, in order. */
+            stages: components["schemas"]["StageView"][];
+        };
         Sandbox: {
             /** @description Sandbox template name, for example "node-24". */
             template: string;
@@ -737,9 +948,38 @@ export type components = {
             agent?: components["schemas"]["Name"];
             /** @description The stage waits for a decision before it starts. */
             gate?: components["schemas"]["Gate"];
+            /**
+             * @description Checks that must succeed on the run's pull request before the stage starts, by their names on the forge, for
+             *     example "verify" (ADR 0069).
+             */
+            checks?: components["schemas"]["CheckName"][];
             /** @description Whether the stage must produce an evidence bundle. */
             evidence?: components["schemas"]["EvidenceRequirement"];
         };
+        /**
+         * @description foreman: where a stage of a run stands.
+         * @enum {string}
+         */
+        StageState: "pending" | "blocked" | "running" | "succeeded" | "failed" | "rejected" | "cancelled";
+        /** @description foreman: one stage of a run (ADR 0067). */
+        StageView: {
+            stage: components["schemas"]["Name"];
+            /** @description The agent that runs the stage. */
+            agent: components["schemas"]["Name"];
+            state: components["schemas"]["StageState"];
+            /** @description The harness session of the stage's agent, once it started. */
+            sessionId?: string;
+            /** @description The gate that decides whether the stage starts, once it was requested. */
+            gateId?: string;
+            /** @description The checks the stage waits for, once the foreman read them (ADR 0069). */
+            checks?: components["schemas"]["CheckView"][];
+            /** @description Why the stage ended without success, when the foreman knows. */
+            reason?: string;
+            /** Format: date-time */
+            startedAt?: string;
+            /** Format: date-time */
+            endedAt?: string;
+        };
         /** @description An OpenTelemetry trace ID: 32 lowercase hex characters. */
         TraceId: string;
         /** @enum {string} */
@@ -765,8 +1005,23 @@ export type components = {
             /** @description Related material: an error report, a change, a document. */
             links?: components["schemas"]["Link"][];
         };
+        /**
+         * @description Where a work item stands.
+         * @enum {string}
+         */
+        WorkItemStatus: "received";
         /** @enum {string} */
         WorkItemType: "idea" | "bug" | "task" | "automation";
+        /** @description intake: a work item as the HTTP API shows it (ADR 0063). */
+        WorkItemView: {
+            /** @description Its ID is "wi_" and 20 hex digits of the SHA-256 of its dedupe key. */
+            workItem: components["schemas"]["WorkItem"];
+            status: components["schemas"]["WorkItemStatus"];
+            /** Format: date-time */
+            receivedAt: string;
+            /** @description Every submission that asked for the work item, oldest first; one per origin. */
+            requests: components["schemas"]["WorkRequest"][];
+        };
         /** @description intake: a work item was accepted. */
         WorkReceived: {
             /** @constant */
@@ -789,6 +1044,26 @@ export type components = {
             traceparent?: string;
             data: components["schemas"]["WorkItem"];
         };
+        /** @description intake: one submission that asked for a work item. */
+        WorkRequest: {
+            requester: components["schemas"]["Actor"];
+            origin: components["schemas"]["Origin"];
+            /** Format: date-time */
+            receivedAt: string;
+        };
+        /** @description intake: work to put into the inbox, a work item without its ID (ADR 0063). */
+        WorkSubmission: {
+            /** @description Default: task. */
+            type?: components["schemas"]["WorkItemType"];
+            title: string;
+            description?: string;
+            requester: components["schemas"]["Actor"];
+            origin: components["schemas"]["Origin"];
+            /** @description Requests with the same key become one work item. Default: the origin's url, else "<source>:<externalId>". */
+            dedupeKey?: string;
+            surface?: string;
+            links?: components["schemas"]["Link"][];
+        };
     };
     responses: never;
     parameters: never;
@@ -889,4 +1164,297 @@ export interface operations {
             };
         };
     };
+    ForemanApi_startRun: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WorkItem"];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunView"];
+                };
+            };
+            /** @description The request has succeeded and a new resource has been created as a result. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunView"];
+                };
+            };
+            /** @description The server could not understand the request due to invalid syntax. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
+    ForemanApi_getRun: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunView"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description The server cannot find the requested resource. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
+    ForemanApi_signalRun: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RunSignal"];
+            };
+        };
+        responses: {
+            /** @description The request has been accepted for processing, but processing has not yet completed. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunView"];
+                };
+            };
+            /** @description The server could not understand the request due to invalid syntax. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description The server cannot find the requested resource. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description The request conflicts with the current state of the server. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
+    IntakeApi_findWorkItem: {
+        parameters: {
+            query: {
+                dedupeKey: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkItemView"];
+                };
+            };
+            /** @description The server could not understand the request due to invalid syntax. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description The server cannot find the requested resource. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
+    IntakeApi_submitWork: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WorkSubmission"];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkItemView"];
+                };
+            };
+            /** @description The request has succeeded and a new resource has been created as a result. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkItemView"];
+                };
+            };
+            /** @description The server could not understand the request due to invalid syntax. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
+    IntakeApi_getWorkItem: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workItemId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkItemView"];
+                };
+            };
+            /** @description Access is unauthorized. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+            /** @description The server cannot find the requested resource. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ApiProblem"];
+                };
+            };
+        };
+    };
 }