@hardfin/cli 0.0.2-dev.7 → 0.0.2-dev.8

package/README.md

@@ -31,6 +31,7 @@ Most commands are generated from the published API document rather than written
 | `hardfin api` | A call to any endpoint, written by hand, and the escape hatch when no generated command fits |
 | `src/command/surface.generated.ts` | Every endpoint as a command, rewritten by the generator |
 | `surface-overrides.json` | The operations whose generated name is wrong |
+| `spec/core.openapi.yaml` | The API document the generator reads, vendored here |
 | `scripts/generate-surface.mjs` | The generator |
 
 ### How an endpoint becomes a command
@@ -70,20 +71,31 @@ Settle it in `surface-overrides.json`, keyed by `operationId`:
 An override for an `operationId` the document no longer publishes fails the generator. That
 is deliberate, because a silently dropped override renames a command nobody meant to rename.
 
-### Regenerating
+### The vendored document
 
-The Surface workflow runs each weekday, reads `reference/core.openapi.yaml` from the
-`hardfinhq/api-spec` repository through a read-only deploy key, and opens a pull request when
-the generated file changes. It needs the `API_SPEC_READ_DEPLOY_KEY` secret.
+`spec/core.openapi.yaml` is the API document this repository carries, and the generator
+reads it. Nothing fetches a document during a build, a release, or CI.
 
-Run it by hand against a local document:
+Refresh it with the script, which then rewrites the generated commands:
 
 ```sh
-npm run generate-surface -- ../api-spec/reference/core.openapi.yaml
+scripts/update-spec.sh              # reads hardfinhq/api-spec over your own git access
+scripts/update-spec.sh ../hardfin   # bundles the fragmented source in a monorepo checkout
 ```
 
-The document is bundled, meaning its external files are inlined, but `$ref` pointers within
-it remain. The generator follows those pointers itself.
+The monorepo form runs the same bundler at the same version CI uses, so the result matches
+what the api-spec bridge publishes. Commit the document and the generated commands together.
+
+Two checks keep the pair honest.
+
+| Check | Refuses |
+| --- | --- |
+| The generator | a document whose `info.version` is not a date, which means an earlier release |
+| CI | a vendored document that was updated without regenerating the commands |
+
+The first one matters because `hardfinhq/api-spec` can sit a release behind the monorepo
+while its bridge pull request is open. Generating from that document would replace the
+current commands with an earlier API's.
 
 ## Local configuration
 

package/dist/cli.js

@@ -765,6 +765,44 @@ const commands = [
 					queryFlags: [],
 					takesBody: true
 				}),
+				{
+					name: "move",
+					summary: "Move commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [{
+						name: "execute",
+						summary: "Execute commands",
+						arguments: [],
+						flags: [],
+						examples: [],
+						subcommands: [defineOperation({
+							name: "create",
+							summary: "Execute asset move",
+							method: "POST",
+							path: "/asset/move/execute",
+							pathParameters: [],
+							queryFlags: [],
+							takesBody: true
+						})]
+					}, {
+						name: "plan",
+						summary: "Plan commands",
+						arguments: [],
+						flags: [],
+						examples: [],
+						subcommands: [defineOperation({
+							name: "create",
+							summary: "Plan asset move",
+							method: "POST",
+							path: "/asset/move/plan",
+							pathParameters: [],
+							queryFlags: [],
+							takesBody: true
+						})]
+					}]
+				},
 				defineOperation({
 					name: "get",
 					summary: "Get asset",
@@ -850,6 +888,74 @@ const commands = [
 						takesBody: true
 					})]
 				},
+				{
+					name: "event",
+					summary: "Event commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [defineOperation({
+						name: "list",
+						summary: "Get asset event list",
+						method: "GET",
+						path: "/asset/{assetKey}/event",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}],
+						queryFlags: [],
+						takesBody: false
+					})]
+				},
+				{
+					name: "event-group",
+					summary: "Event group commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [defineOperation({
+						name: "list",
+						summary: "Get asset event group listing",
+						method: "GET",
+						path: "/asset/{assetKey}/event-group",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}],
+						queryFlags: [{
+							name: "start",
+							queryName: "start",
+							description: "The earliest an event group may have happened, or null to read from the first",
+							valueName: "value",
+							schema: z.string()
+						}, {
+							name: "end",
+							queryName: "end",
+							description: "The latest an event group may have happened, or null to read through the last",
+							valueName: "value",
+							schema: z.string()
+						}],
+						takesBody: false
+					}), defineOperation({
+						name: "get",
+						summary: "Get asset event group",
+						method: "GET",
+						path: "/asset/{assetKey}/event-group/{eventGroupKey}",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}, {
+							name: "eventGroupKey",
+							description: "The event group's key",
+							required: true
+						}],
+						queryFlags: [],
+						takesBody: false
+					})]
+				},
 				{
 					name: "file",
 					summary: "File commands",
@@ -886,6 +992,26 @@ const commands = [
 						takesBody: false
 					})]
 				},
+				{
+					name: "functional-status",
+					summary: "Functional status commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [defineOperation({
+						name: "list",
+						summary: "Get asset functional status history",
+						method: "GET",
+						path: "/asset/{assetKey}/functional-status",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}],
+						queryFlags: [],
+						takesBody: false
+					})]
+				},
 				{
 					name: "ownership",
 					summary: "Ownership commands",
@@ -985,6 +1111,46 @@ const commands = [
 						})
 					]
 				},
+				{
+					name: "scrap",
+					summary: "Scrap commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [defineOperation({
+						name: "create",
+						summary: "Scrap asset",
+						method: "POST",
+						path: "/asset/{assetKey}/scrap",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}],
+						queryFlags: [],
+						takesBody: true
+					})]
+				},
+				{
+					name: "unscrap",
+					summary: "Unscrap commands",
+					arguments: [],
+					flags: [],
+					examples: [],
+					subcommands: [defineOperation({
+						name: "create",
+						summary: "Unscrap asset",
+						method: "POST",
+						path: "/asset/{assetKey}/unscrap",
+						pathParameters: [{
+							name: "assetKey",
+							description: "The asset's key",
+							required: true
+						}],
+						queryFlags: [],
+						takesBody: false
+					})]
+				},
 				{
 					name: "url-link",
 					summary: "URL link commands",
@@ -1186,9 +1352,8 @@ const commands = [
 				queryFlags: [{
 					name: "attachment",
 					queryName: "attachment",
-					description: "Present, with any value or none, when the file should download as an attachment rather than open inline",
-					valueName: "value",
-					schema: z.string()
+					description: "True when the file downloads as an attachment rather than opening inline",
+					schema: z.boolean()
 				}],
 				takesBody: false
 			})]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hardfin/cli",
-    "version": "0.0.2-dev.7",
+    "version": "0.0.2-dev.8",
     "description": "Command line interface for the Hardfin API",
     "license": "Apache-2.0",
     "author": "Hardfin, Inc.",