@typeship-ax/cli 0.21.1 → 0.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/README.md +1 -1
- package/api.json +173 -141
- package/api.md +33 -33
- package/dist/cli.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/ops.js +22 -22
- package/dist/resources/api-keys.d.ts +6 -5
- package/dist/resources/api-keys.d.ts.map +1 -1
- package/dist/resources/deliveries.d.ts +7 -6
- package/dist/resources/deliveries.d.ts.map +1 -1
- package/dist/resources/deliveries.js +1 -1
- package/dist/resources/drafts.d.ts +12 -10
- package/dist/resources/drafts.d.ts.map +1 -1
- package/dist/resources/generations.d.ts +12 -10
- package/dist/resources/generations.d.ts.map +1 -1
- package/dist/resources/projects.d.ts +14 -13
- package/dist/resources/projects.d.ts.map +1 -1
- package/dist/resources/projects.js +8 -8
- package/dist/resources/publications.d.ts +7 -6
- package/dist/resources/publications.d.ts.map +1 -1
- package/dist/resources/publications.js +1 -1
- package/dist/resources/releases.d.ts +8 -6
- package/dist/resources/releases.d.ts.map +1 -1
- package/dist/resources/releases.js +2 -1
- package/dist/resources/spec-revisions.d.ts +12 -10
- package/dist/resources/spec-revisions.d.ts.map +1 -1
- package/dist/resources/specs.d.ts +2 -1
- package/dist/resources/specs.d.ts.map +1 -1
- package/dist/resources/specs.js +2 -1
- package/dist/resources/targets.d.ts +9 -8
- package/dist/resources/targets.d.ts.map +1 -1
- package/dist/resources/targets.js +3 -3
- package/dist/types.d.ts +41 -28
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +40 -27
- package/package.json +1 -1
- package/src/cli.ts +2 -2
- package/src/index.ts +3 -3
- package/src/ops.ts +22 -22
- package/src/resources/api-keys.ts +6 -5
- package/src/resources/deliveries.ts +7 -6
- package/src/resources/drafts.ts +12 -10
- package/src/resources/generations.ts +12 -10
- package/src/resources/projects.ts +14 -13
- package/src/resources/publications.ts +7 -6
- package/src/resources/releases.ts +8 -6
- package/src/resources/spec-revisions.ts +12 -10
- package/src/resources/specs.ts +2 -1
- package/src/resources/targets.ts +9 -8
- package/src/types.ts +41 -28
package/api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# typeship — CLI reference
|
|
2
2
|
|
|
3
|
-
API version 1.0.0. Package version 0.
|
|
3
|
+
API version 1.0.0. Package version 0.22.0. Generated by typeship.
|
|
4
4
|
|
|
5
5
|
Run `typeship help --json` for the command index. Path arguments are positional; flags use the names shown below. Arrays accept repeated flags, comma-separated values, or a JSON array; object values use JSON.
|
|
6
6
|
|
|
@@ -86,8 +86,8 @@ Safety: **read** · Authentication: **required**
|
|
|
86
86
|
|
|
87
87
|
| Argument or flag | In | Type | Required | Description |
|
|
88
88
|
| --- | --- | --- | --- | --- |
|
|
89
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
90
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
89
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
90
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
91
91
|
|
|
92
92
|
```sh
|
|
93
93
|
typeship projects list
|
|
@@ -159,7 +159,7 @@ Delete a project
|
|
|
159
159
|
|
|
160
160
|
Safety: **destructive** · Authentication: **required**
|
|
161
161
|
|
|
162
|
-
A `502`
|
|
162
|
+
A `502 repository_unavailable` means the Project was not deleted because its release pull requests could not be retired. Retry deletion to finish retiring the remaining reviews. Repeating a completed deletion returns `404`.
|
|
163
163
|
See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.
|
|
164
164
|
|
|
165
165
|
| Argument or flag | In | Type | Required | Description |
|
|
@@ -188,7 +188,7 @@ With auto_generate enabled, changing shared config queues a Generation for each
|
|
|
188
188
|
Omitting If-Match applies the update to the current resource; with If-Match, a stale ETag returns 412 precondition_failed without saving.
|
|
189
189
|
|
|
190
190
|
A `409 target_busy` means a Target is publishing. Retrieve the Project, wait for publishing to finish, reconcile your update, and retry.
|
|
191
|
-
A `502`
|
|
191
|
+
A `502 follow_up_failed` means the Project was saved, but an obsolete release pull request could not be retired. Retrieve the Project and retry the same update to finish retiring reviews if that update is still desired.
|
|
192
192
|
See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.
|
|
193
193
|
|
|
194
194
|
| Argument or flag | In | Type | Required | Description |
|
|
@@ -217,7 +217,7 @@ Start generation for active Targets
|
|
|
217
217
|
|
|
218
218
|
Safety: **write** · Authentication: **required**
|
|
219
219
|
|
|
220
|
-
Queues one Generation per active Target and returns their IDs. Retrieve each Generation until its status moves from `queued` to `running` and then `completed` or `failed`. `completed` means generated files are saved; check Delivery and Draft status separately for repository delivery and pull requests. A Target already queued or running is returned without starting another Generation. A matching Idempotency-Key replay returns the same Generations with their current statuses.
|
|
220
|
+
Queues one Generation per active Target and returns their IDs. Retrieve each Generation until its status moves from `queued` to `running` and then `completed` or `failed`. `completed` means generated files are saved; check Delivery and Draft status separately for repository delivery and pull requests. A Target already queued or running is returned without starting another Generation. A `409 targets_inactive` means the Project has no active Target to generate. A matching Idempotency-Key replay returns the same Generations with their current statuses.
|
|
221
221
|
|
|
222
222
|
If the package already matches a destination and no Draft is open, delivery creates no commit, branch, or pull request. An existing Draft stays open. Automatic generation uses the same workflow.
|
|
223
223
|
|
|
@@ -302,7 +302,7 @@ Refresh a Spec from its configured source
|
|
|
302
302
|
|
|
303
303
|
Safety: **write** · Authentication: **required**
|
|
304
304
|
|
|
305
|
-
Fetches the configured source now and creates a new Spec Revision only when its content changes. Diagnostics then reads that revision. If automatic generation is enabled, refresh queues generation for active Targets even when the source is unchanged.
|
|
305
|
+
Fetches the configured source now and creates a new Spec Revision only when its content changes. Diagnostics then reads that revision. If automatic generation is enabled, refresh queues generation for active Targets even when the source is unchanged. A `502 follow_up_failed` means the new Spec Revision was recorded but generation could not be queued.
|
|
306
306
|
|
|
307
307
|
| Argument or flag | In | Type | Required | Description |
|
|
308
308
|
| --- | --- | --- | --- | --- |
|
|
@@ -331,8 +331,8 @@ Lists Spec Revisions, newest first. Source content is not included; list a revis
|
|
|
331
331
|
|
|
332
332
|
| Argument or flag | In | Type | Required | Description |
|
|
333
333
|
| --- | --- | --- | --- | --- |
|
|
334
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
335
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
334
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
335
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
336
336
|
| `--spec-id` | query | `string` | no | Only revisions of this Spec. |
|
|
337
337
|
|
|
338
338
|
```sh
|
|
@@ -379,8 +379,8 @@ Lists the captured source files and the resolved document Typeship generated fro
|
|
|
379
379
|
| Argument or flag | In | Type | Required | Description |
|
|
380
380
|
| --- | --- | --- | --- | --- |
|
|
381
381
|
| `<spec_revision_id>` | path | `string` | yes | — |
|
|
382
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
383
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
382
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
383
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
384
384
|
|
|
385
385
|
```sh
|
|
386
386
|
typeship spec-revisions list-files srev_6m1q8v4k2p9d7h3c
|
|
@@ -402,8 +402,8 @@ Safety: **read** · Authentication: **required**
|
|
|
402
402
|
|
|
403
403
|
| Argument or flag | In | Type | Required | Description |
|
|
404
404
|
| --- | --- | --- | --- | --- |
|
|
405
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
406
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
405
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
406
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
407
407
|
| `--project-id` | query | `string` | no | Only Targets in this Project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list. |
|
|
408
408
|
|
|
409
409
|
```sh
|
|
@@ -506,7 +506,7 @@ Omitting If-Match applies the update to the current resource; with If-Match, a s
|
|
|
506
506
|
Select the next version through PATCH /drafts/{draft_id} on the Target's draft_id.
|
|
507
507
|
|
|
508
508
|
A `409 target_busy` means the Target is publishing; wait for it to finish. A `409 delivery_conflict` means another Target owns the requested repository tree; retrieve both Targets, choose a free destination, and retry.
|
|
509
|
-
A `502`
|
|
509
|
+
A `502 follow_up_failed` means the update was saved, but retiring an obsolete review or regenerating the Target failed. Retrieve the Target and follow the error's retryable and suggested_action fields.
|
|
510
510
|
See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.
|
|
511
511
|
|
|
512
512
|
| Argument or flag | In | Type | Required | Description |
|
|
@@ -571,8 +571,8 @@ Lists open and merged Drafts, newest first. Each Target has one open Draft; each
|
|
|
571
571
|
|
|
572
572
|
| Argument or flag | In | Type | Required | Description |
|
|
573
573
|
| --- | --- | --- | --- | --- |
|
|
574
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
575
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
574
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
575
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
576
576
|
| `--target-id` | query | `string` | no | Only Drafts of this Target. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list. |
|
|
577
577
|
| `--status` | query | `string` | no | Only Drafts with this status. |
|
|
578
578
|
|
|
@@ -654,8 +654,8 @@ Returns `409 resource_changed` while Typeship is carrying the Draft's latest com
|
|
|
654
654
|
| --- | --- | --- | --- | --- |
|
|
655
655
|
| `<draft_id>` | path | `string` | yes | — |
|
|
656
656
|
| `--filter` | query | `string` | no | conflicted: conflicts only. customized: files that differ from the last merged package. history: files affected by a default-branch history rewrite. Omit for conflicted and customized files. |
|
|
657
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
658
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
657
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
658
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
659
659
|
|
|
660
660
|
```sh
|
|
661
661
|
typeship drafts list-files drf_3q7m1v8k2p5d9h4c
|
|
@@ -731,8 +731,8 @@ Safety: **read** · Authentication: **required**
|
|
|
731
731
|
|
|
732
732
|
| Argument or flag | In | Type | Required | Description |
|
|
733
733
|
| --- | --- | --- | --- | --- |
|
|
734
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
735
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
734
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
735
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
736
736
|
| `--target-id` | query | `string` | no | Only releases of this Target. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list. |
|
|
737
737
|
|
|
738
738
|
```sh
|
|
@@ -773,7 +773,7 @@ Safety: **write** · Authentication: **required**
|
|
|
773
773
|
|
|
774
774
|
Retries publishing the specified release through its repository workflow. Uses that release's version and accepted commit, even if a newer Draft or release exists.
|
|
775
775
|
|
|
776
|
-
A `502`
|
|
776
|
+
A `502 repository_unavailable` means the repository publishing workflow could not be dispatched, and nothing was changed.
|
|
777
777
|
|
|
778
778
|
| Argument or flag | In | Type | Required | Description |
|
|
779
779
|
| --- | --- | --- | --- | --- |
|
|
@@ -800,8 +800,8 @@ Safety: **read** · Authentication: **required**
|
|
|
800
800
|
|
|
801
801
|
| Argument or flag | In | Type | Required | Description |
|
|
802
802
|
| --- | --- | --- | --- | --- |
|
|
803
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
804
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
803
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
804
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
805
805
|
| `--target-id` | query | `string` | no | Only Deliveries of this Target. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list. |
|
|
806
806
|
|
|
807
807
|
```sh
|
|
@@ -820,7 +820,7 @@ Get a Delivery
|
|
|
820
820
|
|
|
821
821
|
Safety: **read** · Authentication: **required**
|
|
822
822
|
|
|
823
|
-
Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another organization returns 404
|
|
823
|
+
Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another organization returns 404 resource_not_found.
|
|
824
824
|
|
|
825
825
|
| Argument or flag | In | Type | Required | Description |
|
|
826
826
|
| --- | --- | --- | --- | --- |
|
|
@@ -846,8 +846,8 @@ Safety: **read** · Authentication: **required**
|
|
|
846
846
|
|
|
847
847
|
| Argument or flag | In | Type | Required | Description |
|
|
848
848
|
| --- | --- | --- | --- | --- |
|
|
849
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
850
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
849
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
850
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
851
851
|
| `--release-id` | query | `string` | no | Only publications of this release. |
|
|
852
852
|
|
|
853
853
|
```sh
|
|
@@ -866,7 +866,7 @@ Get publishing status
|
|
|
866
866
|
|
|
867
867
|
Safety: **read** · Authentication: **required**
|
|
868
868
|
|
|
869
|
-
Returns the registry publishing status for a release. A status in another organization returns 404
|
|
869
|
+
Returns the registry publishing status for a release. A status in another organization returns 404 resource_not_found.
|
|
870
870
|
|
|
871
871
|
| Argument or flag | In | Type | Required | Description |
|
|
872
872
|
| --- | --- | --- | --- | --- |
|
|
@@ -892,8 +892,8 @@ Safety: **read** · Authentication: **required**
|
|
|
892
892
|
|
|
893
893
|
| Argument or flag | In | Type | Required | Description |
|
|
894
894
|
| --- | --- | --- | --- | --- |
|
|
895
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
896
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
895
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
896
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
897
897
|
| `--project-id` | query | `string` | no | Only Generations in this Project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list. |
|
|
898
898
|
| `--target-id` | query | `string` | no | Only Generations of this Target. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list. |
|
|
899
899
|
| `--status` | query | `string` | no | Only Generations with this status. |
|
|
@@ -941,8 +941,8 @@ Lists the generated package's files, ordered by path. Read content with getFile.
|
|
|
941
941
|
| Argument or flag | In | Type | Required | Description |
|
|
942
942
|
| --- | --- | --- | --- | --- |
|
|
943
943
|
| `<generation_id>` | path | `string` | yes | Accepts an ID or an exact name (resolved via generations_list). IDs come from generations_list. |
|
|
944
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
945
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
944
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
945
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
946
946
|
|
|
947
947
|
```sh
|
|
948
948
|
typeship generations list-files gen_7h2p5d9c3m8w1k6q
|
|
@@ -1011,8 +1011,8 @@ Lists key metadata and the last four characters of each key. Full keys are not r
|
|
|
1011
1011
|
|
|
1012
1012
|
| Argument or flag | In | Type | Required | Description |
|
|
1013
1013
|
| --- | --- | --- | --- | --- |
|
|
1014
|
-
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
1015
|
-
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty
|
|
1014
|
+
| `--limit` | query | `number` | no | Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 input_invalid. List query parameters must appear only once; repeated or unrecognized parameters return 400 query_param_invalid. Default: 20. |
|
|
1015
|
+
| `--cursor` | query | `string` | no | Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty or malformed cursors, and cursors issued for different filters, return 400 cursor_invalid; start again from the first page. Repeated cursors return 400 query_param_invalid. The page limit may change between requests. |
|
|
1016
1016
|
|
|
1017
1017
|
```sh
|
|
1018
1018
|
typeship api-keys list
|
package/dist/cli.js
CHANGED
|
@@ -35,7 +35,7 @@ const BASIC = null;
|
|
|
35
35
|
const EXCLUDED_OPS = 0;
|
|
36
36
|
/** Generated CLI operations that are intentionally unavailable to MCP. */
|
|
37
37
|
const MCP_EXCLUDED_OPS = 0;
|
|
38
|
-
const VERSION = "0.
|
|
38
|
+
const VERSION = "0.22.0";
|
|
39
39
|
const API_VERSION = "1.0.0";
|
|
40
40
|
const SPEC_FORMAT = "openapi";
|
|
41
41
|
const IDENTITY_POLICY = {};
|
|
@@ -2022,7 +2022,7 @@ function printRoot(stream = process.stdout) {
|
|
|
2022
2022
|
}
|
|
2023
2023
|
const width = termWidth();
|
|
2024
2024
|
const lines = [];
|
|
2025
|
-
lines.push(paintOut("bold", BIN) + ": " + "typeship API" + " (v" + "1.0.0" + "), package " + "0.
|
|
2025
|
+
lines.push(paintOut("bold", BIN) + ": " + "typeship API" + " (v" + "1.0.0" + "), package " + "0.22.0");
|
|
2026
2026
|
lines.push("");
|
|
2027
2027
|
lines.push(paintOut("bold", "Usage:") + " " + BIN + " <resource> <command> [args] [--flags]");
|
|
2028
2028
|
lines.push("");
|
package/dist/index.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ import { FilesResource } from "./resources/files.js";
|
|
|
13
13
|
import { OrganizationResource } from "./resources/organization.js";
|
|
14
14
|
import { ApiKeysResource } from "./resources/api-keys.js";
|
|
15
15
|
/** This package's version, also sent as the `User-Agent`. */
|
|
16
|
-
export declare const VERSION = "0.
|
|
16
|
+
export declare const VERSION = "0.22.0";
|
|
17
17
|
export interface ClientOptions {
|
|
18
18
|
/** Override the server URL. Default: `https://typeship.dev/api/v1` */
|
|
19
19
|
baseUrl?: string;
|
|
@@ -73,7 +73,7 @@ export interface ClientOptions {
|
|
|
73
73
|
};
|
|
74
74
|
}
|
|
75
75
|
/**
|
|
76
|
-
* typeship — v0.
|
|
76
|
+
* typeship — v0.22.0
|
|
77
77
|
*
|
|
78
78
|
* Resolve an OpenAPI or GraphQL Spec, diagnose it, and keep every
|
|
79
79
|
* selected CLI, MCP, and SDK Target current.
|
package/dist/index.js
CHANGED
|
@@ -16,10 +16,10 @@ import { FilesResource } from "./resources/files.js";
|
|
|
16
16
|
import { OrganizationResource } from "./resources/organization.js";
|
|
17
17
|
import { ApiKeysResource } from "./resources/api-keys.js";
|
|
18
18
|
/** This package's version, also sent as the `User-Agent`. */
|
|
19
|
-
export const VERSION = "0.
|
|
20
|
-
const USER_AGENT = "@typeship-ax/cli/0.
|
|
19
|
+
export const VERSION = "0.22.0";
|
|
20
|
+
const USER_AGENT = "@typeship-ax/cli/0.22.0";
|
|
21
21
|
/**
|
|
22
|
-
* typeship — v0.
|
|
22
|
+
* typeship — v0.22.0
|
|
23
23
|
*
|
|
24
24
|
* Resolve an OpenAPI or GraphQL Spec, diagnose it, and keep every
|
|
25
25
|
* selected CLI, MCP, and SDK Target current.
|