@typeship-ax/cli 0.21.0 → 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 +2 -2
- 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.json
CHANGED
|
@@ -1053,7 +1053,7 @@
|
|
|
1053
1053
|
"type": "string"
|
|
1054
1054
|
},
|
|
1055
1055
|
"spec_digest": {
|
|
1056
|
-
"description": "SHA-256 hex digest of the Spec the SDK was generated from. Must match the resolved Spec, or the request fails with
|
|
1056
|
+
"description": "SHA-256 hex digest of the Spec the SDK was generated from. Must match the resolved Spec, or the request fails with spec_invalid.",
|
|
1057
1057
|
"pattern": "^[a-f0-9]{64}$",
|
|
1058
1058
|
"type": "string"
|
|
1059
1059
|
},
|
|
@@ -1987,14 +1987,14 @@
|
|
|
1987
1987
|
"minimum": 1,
|
|
1988
1988
|
"maximum": 100,
|
|
1989
1989
|
"type": "integer",
|
|
1990
|
-
"description": "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
|
|
1990
|
+
"description": "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."
|
|
1991
1991
|
},
|
|
1992
1992
|
"cursor": {
|
|
1993
1993
|
"minLength": 1,
|
|
1994
1994
|
"maxLength": 2048,
|
|
1995
1995
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
1996
1996
|
"type": "string",
|
|
1997
|
-
"description": "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
|
|
1997
|
+
"description": "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."
|
|
1998
1998
|
}
|
|
1999
1999
|
}
|
|
2000
2000
|
},
|
|
@@ -3306,7 +3306,7 @@
|
|
|
3306
3306
|
"method": "DELETE",
|
|
3307
3307
|
"path": "/projects/{project_id}",
|
|
3308
3308
|
"summary": "Delete a project",
|
|
3309
|
-
"description": "A `502`
|
|
3309
|
+
"description": "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`.\nSee [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.",
|
|
3310
3310
|
"safety": "destructive",
|
|
3311
3311
|
"auth": "required",
|
|
3312
3312
|
"security": [
|
|
@@ -3419,7 +3419,7 @@
|
|
|
3419
3419
|
"method": "PATCH",
|
|
3420
3420
|
"path": "/projects/{project_id}",
|
|
3421
3421
|
"summary": "Update a project",
|
|
3422
|
-
"description": "Omitted fields keep their current values. A supplied config replaces the entire stored object; null or an empty object clears it.\nWith auto_generate enabled, changing shared config queues a Generation for each Target whose effective config changes. A queued or running Target reuses that Generation.\nOmitting If-Match applies the update to the current resource; with If-Match, a stale ETag returns 412 precondition_failed without saving.\n\nA `409 target_busy` means a Target is publishing. Retrieve the Project, wait for publishing to finish, reconcile your update, and retry.\nA `502`
|
|
3422
|
+
"description": "Omitted fields keep their current values. A supplied config replaces the entire stored object; null or an empty object clears it.\nWith auto_generate enabled, changing shared config queues a Generation for each Target whose effective config changes. A queued or running Target reuses that Generation.\nOmitting If-Match applies the update to the current resource; with If-Match, a stale ETag returns 412 precondition_failed without saving.\n\nA `409 target_busy` means a Target is publishing. Retrieve the Project, wait for publishing to finish, reconcile your update, and retry.\nA `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.\nSee [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.",
|
|
3423
3423
|
"safety": "write",
|
|
3424
3424
|
"auth": "required",
|
|
3425
3425
|
"security": [
|
|
@@ -3965,7 +3965,7 @@
|
|
|
3965
3965
|
"method": "POST",
|
|
3966
3966
|
"path": "/projects/{project_id}/generate",
|
|
3967
3967
|
"summary": "Start generation for active Targets",
|
|
3968
|
-
"description": "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.\n\nIf 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.",
|
|
3968
|
+
"description": "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.\n\nIf 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.",
|
|
3969
3969
|
"safety": "write",
|
|
3970
3970
|
"auth": "required",
|
|
3971
3971
|
"security": [
|
|
@@ -5208,7 +5208,7 @@
|
|
|
5208
5208
|
"method": "POST",
|
|
5209
5209
|
"path": "/specs/{spec_id}/refresh",
|
|
5210
5210
|
"summary": "Refresh a Spec from its configured source",
|
|
5211
|
-
"description": "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.",
|
|
5211
|
+
"description": "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.",
|
|
5212
5212
|
"safety": "write",
|
|
5213
5213
|
"auth": "required",
|
|
5214
5214
|
"security": [
|
|
@@ -5579,14 +5579,14 @@
|
|
|
5579
5579
|
"minimum": 1,
|
|
5580
5580
|
"maximum": 100,
|
|
5581
5581
|
"type": "integer",
|
|
5582
|
-
"description": "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
|
|
5582
|
+
"description": "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."
|
|
5583
5583
|
},
|
|
5584
5584
|
"cursor": {
|
|
5585
5585
|
"minLength": 1,
|
|
5586
5586
|
"maxLength": 2048,
|
|
5587
5587
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
5588
5588
|
"type": "string",
|
|
5589
|
-
"description": "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
|
|
5589
|
+
"description": "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."
|
|
5590
5590
|
},
|
|
5591
5591
|
"spec_id": {
|
|
5592
5592
|
"description": "Unique identifier for a project's logical API Spec.",
|
|
@@ -6271,14 +6271,14 @@
|
|
|
6271
6271
|
"minimum": 1,
|
|
6272
6272
|
"maximum": 100,
|
|
6273
6273
|
"type": "integer",
|
|
6274
|
-
"description": "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
|
|
6274
|
+
"description": "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."
|
|
6275
6275
|
},
|
|
6276
6276
|
"cursor": {
|
|
6277
6277
|
"minLength": 1,
|
|
6278
6278
|
"maxLength": 2048,
|
|
6279
6279
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
6280
6280
|
"type": "string",
|
|
6281
|
-
"description": "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
|
|
6281
|
+
"description": "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."
|
|
6282
6282
|
}
|
|
6283
6283
|
},
|
|
6284
6284
|
"required": [
|
|
@@ -6431,14 +6431,14 @@
|
|
|
6431
6431
|
"minimum": 1,
|
|
6432
6432
|
"maximum": 100,
|
|
6433
6433
|
"type": "integer",
|
|
6434
|
-
"description": "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
|
|
6434
|
+
"description": "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."
|
|
6435
6435
|
},
|
|
6436
6436
|
"cursor": {
|
|
6437
6437
|
"minLength": 1,
|
|
6438
6438
|
"maxLength": 2048,
|
|
6439
6439
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
6440
6440
|
"type": "string",
|
|
6441
|
-
"description": "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
|
|
6441
|
+
"description": "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."
|
|
6442
6442
|
},
|
|
6443
6443
|
"project_id": {
|
|
6444
6444
|
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
@@ -8053,7 +8053,7 @@
|
|
|
8053
8053
|
"method": "PATCH",
|
|
8054
8054
|
"path": "/targets/{target_id}",
|
|
8055
8055
|
"summary": "Update a Target or its Deliveries",
|
|
8056
|
-
"description": "Omitted fields keep their current values. Supplied config, checks, and deliveries replace their complete stored values.\nWith Project auto_generate enabled, changing Target config, checks, or Deliveries queues that Target's Generation. A queued or running Target reuses that Generation.\nOmitting If-Match applies the update to the current resource; with If-Match, a stale ETag returns 412 precondition_failed without saving.\nSelect the next version through PATCH /drafts/{draft_id} on the Target's draft_id.\n\nA `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.\nA `502`
|
|
8056
|
+
"description": "Omitted fields keep their current values. Supplied config, checks, and deliveries replace their complete stored values.\nWith Project auto_generate enabled, changing Target config, checks, or Deliveries queues that Target's Generation. A queued or running Target reuses that Generation.\nOmitting If-Match applies the update to the current resource; with If-Match, a stale ETag returns 412 precondition_failed without saving.\nSelect the next version through PATCH /drafts/{draft_id} on the Target's draft_id.\n\nA `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.\nA `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.\nSee [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.",
|
|
8057
8057
|
"safety": "write",
|
|
8058
8058
|
"auth": "required",
|
|
8059
8059
|
"security": [
|
|
@@ -9292,14 +9292,14 @@
|
|
|
9292
9292
|
"minimum": 1,
|
|
9293
9293
|
"maximum": 100,
|
|
9294
9294
|
"type": "integer",
|
|
9295
|
-
"description": "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
|
|
9295
|
+
"description": "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."
|
|
9296
9296
|
},
|
|
9297
9297
|
"cursor": {
|
|
9298
9298
|
"minLength": 1,
|
|
9299
9299
|
"maxLength": 2048,
|
|
9300
9300
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
9301
9301
|
"type": "string",
|
|
9302
|
-
"description": "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
|
|
9302
|
+
"description": "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."
|
|
9303
9303
|
},
|
|
9304
9304
|
"target_id": {
|
|
9305
9305
|
"description": "Stable identifier for one configured generated product. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list.",
|
|
@@ -10666,14 +10666,14 @@
|
|
|
10666
10666
|
"minimum": 1,
|
|
10667
10667
|
"maximum": 100,
|
|
10668
10668
|
"type": "integer",
|
|
10669
|
-
"description": "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
|
|
10669
|
+
"description": "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."
|
|
10670
10670
|
},
|
|
10671
10671
|
"cursor": {
|
|
10672
10672
|
"minLength": 1,
|
|
10673
10673
|
"maxLength": 2048,
|
|
10674
10674
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
10675
10675
|
"type": "string",
|
|
10676
|
-
"description": "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
|
|
10676
|
+
"description": "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."
|
|
10677
10677
|
}
|
|
10678
10678
|
},
|
|
10679
10679
|
"required": [
|
|
@@ -11959,14 +11959,14 @@
|
|
|
11959
11959
|
"minimum": 1,
|
|
11960
11960
|
"maximum": 100,
|
|
11961
11961
|
"type": "integer",
|
|
11962
|
-
"description": "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
|
|
11962
|
+
"description": "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."
|
|
11963
11963
|
},
|
|
11964
11964
|
"cursor": {
|
|
11965
11965
|
"minLength": 1,
|
|
11966
11966
|
"maxLength": 2048,
|
|
11967
11967
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
11968
11968
|
"type": "string",
|
|
11969
|
-
"description": "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
|
|
11969
|
+
"description": "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."
|
|
11970
11970
|
},
|
|
11971
11971
|
"target_id": {
|
|
11972
11972
|
"description": "Stable identifier for one configured generated product. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list.",
|
|
@@ -12755,7 +12755,7 @@
|
|
|
12755
12755
|
"method": "POST",
|
|
12756
12756
|
"path": "/releases/{release_id}/republish",
|
|
12757
12757
|
"summary": "Retry publishing an exact release",
|
|
12758
|
-
"description": "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.\n\nA `502`
|
|
12758
|
+
"description": "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.\n\nA `502 repository_unavailable` means the repository publishing workflow could not be dispatched, and nothing was changed.",
|
|
12759
12759
|
"safety": "write",
|
|
12760
12760
|
"auth": "required",
|
|
12761
12761
|
"security": [
|
|
@@ -13181,14 +13181,14 @@
|
|
|
13181
13181
|
"minimum": 1,
|
|
13182
13182
|
"maximum": 100,
|
|
13183
13183
|
"type": "integer",
|
|
13184
|
-
"description": "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
|
|
13184
|
+
"description": "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."
|
|
13185
13185
|
},
|
|
13186
13186
|
"cursor": {
|
|
13187
13187
|
"minLength": 1,
|
|
13188
13188
|
"maxLength": 2048,
|
|
13189
13189
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
13190
13190
|
"type": "string",
|
|
13191
|
-
"description": "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
|
|
13191
|
+
"description": "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."
|
|
13192
13192
|
},
|
|
13193
13193
|
"target_id": {
|
|
13194
13194
|
"description": "Stable identifier for one configured generated product. Accepts an ID or an exact name (resolved via targets_list). IDs come from targets_list.",
|
|
@@ -13416,7 +13416,7 @@
|
|
|
13416
13416
|
"method": "GET",
|
|
13417
13417
|
"path": "/deliveries/{delivery_id}",
|
|
13418
13418
|
"summary": "Get a Delivery",
|
|
13419
|
-
"description": "Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another organization returns 404
|
|
13419
|
+
"description": "Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another organization returns 404 resource_not_found.",
|
|
13420
13420
|
"safety": "read",
|
|
13421
13421
|
"auth": "required",
|
|
13422
13422
|
"security": [
|
|
@@ -13666,14 +13666,14 @@
|
|
|
13666
13666
|
"minimum": 1,
|
|
13667
13667
|
"maximum": 100,
|
|
13668
13668
|
"type": "integer",
|
|
13669
|
-
"description": "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
|
|
13669
|
+
"description": "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."
|
|
13670
13670
|
},
|
|
13671
13671
|
"cursor": {
|
|
13672
13672
|
"minLength": 1,
|
|
13673
13673
|
"maxLength": 2048,
|
|
13674
13674
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
13675
13675
|
"type": "string",
|
|
13676
|
-
"description": "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
|
|
13676
|
+
"description": "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."
|
|
13677
13677
|
},
|
|
13678
13678
|
"release_id": {
|
|
13679
13679
|
"examples": [
|
|
@@ -13760,36 +13760,48 @@
|
|
|
13760
13760
|
"properties": {
|
|
13761
13761
|
"type": {
|
|
13762
13762
|
"enum": [
|
|
13763
|
-
"
|
|
13764
|
-
"
|
|
13765
|
-
"
|
|
13766
|
-
"
|
|
13767
|
-
"
|
|
13768
|
-
"
|
|
13769
|
-
"
|
|
13763
|
+
"request",
|
|
13764
|
+
"auth",
|
|
13765
|
+
"idempotency",
|
|
13766
|
+
"rate_limit",
|
|
13767
|
+
"organization",
|
|
13768
|
+
"source",
|
|
13769
|
+
"api"
|
|
13770
13770
|
],
|
|
13771
|
-
"description": "
|
|
13771
|
+
"description": "Who can resolve the error. request: change the request. auth: fix the credential or its grant. idempotency: change or wait on the Idempotency-Key. rate_limit: wait before retrying. organization: the organization's plan must change. source: a system you own failed, such as the Spec URL, repository, or package registry. api: Typeship failed.",
|
|
13772
13772
|
"type": "string"
|
|
13773
13773
|
},
|
|
13774
13774
|
"code": {
|
|
13775
13775
|
"enum": [
|
|
13776
|
-
"
|
|
13776
|
+
"input_invalid",
|
|
13777
|
+
"query_param_invalid",
|
|
13778
|
+
"cursor_invalid",
|
|
13779
|
+
"method_not_allowed",
|
|
13780
|
+
"resource_not_found",
|
|
13781
|
+
"idempotency_key_invalid",
|
|
13777
13782
|
"idempotency_key_reused",
|
|
13778
|
-
"
|
|
13783
|
+
"idempotency_key_in_use",
|
|
13784
|
+
"auth_required",
|
|
13785
|
+
"api_key_invalid",
|
|
13786
|
+
"token_invalid",
|
|
13779
13787
|
"organization_required",
|
|
13780
13788
|
"insufficient_scope",
|
|
13781
|
-
"
|
|
13782
|
-
"
|
|
13783
|
-
"
|
|
13784
|
-
"
|
|
13785
|
-
"
|
|
13789
|
+
"role_insufficient",
|
|
13790
|
+
"rate_limit_exceeded",
|
|
13791
|
+
"plan_limit_reached",
|
|
13792
|
+
"spec_invalid",
|
|
13793
|
+
"spec_too_large",
|
|
13794
|
+
"spec_unreachable",
|
|
13786
13795
|
"repository_provider_unsupported",
|
|
13796
|
+
"repository_disconnected",
|
|
13797
|
+
"repository_unavailable",
|
|
13787
13798
|
"target_busy",
|
|
13799
|
+
"targets_inactive",
|
|
13788
13800
|
"no_draft",
|
|
13789
13801
|
"draft_merged",
|
|
13790
13802
|
"resource_changed",
|
|
13791
|
-
"invalid_version",
|
|
13792
13803
|
"precondition_failed",
|
|
13804
|
+
"version_invalid",
|
|
13793
13805
|
"version_occupied",
|
|
13794
13806
|
"version_too_low",
|
|
13795
13807
|
"target_already_released",
|
|
@@ -13797,15 +13809,12 @@
|
|
|
13797
13809
|
"publication_disabled",
|
|
13798
13810
|
"publication_not_retryable",
|
|
13799
13811
|
"publication_recovery_unavailable",
|
|
13800
|
-
"
|
|
13801
|
-
"repository_disconnected",
|
|
13802
|
-
"regeneration_failed",
|
|
13812
|
+
"publication_failed",
|
|
13803
13813
|
"delivery_conflict",
|
|
13804
13814
|
"resource_has_dependencies",
|
|
13805
|
-
"
|
|
13806
|
-
"
|
|
13807
|
-
"
|
|
13808
|
-
"internal_error",
|
|
13815
|
+
"customization_conflict",
|
|
13816
|
+
"history_recovery_required",
|
|
13817
|
+
"checks_unavailable",
|
|
13809
13818
|
"dependency_missing",
|
|
13810
13819
|
"dependency_not_found",
|
|
13811
13820
|
"dependency_self",
|
|
@@ -13817,10 +13826,9 @@
|
|
|
13817
13826
|
"dependency_module_path_missing",
|
|
13818
13827
|
"dependency_unreleased",
|
|
13819
13828
|
"dependency_revision_mismatch",
|
|
13820
|
-
"
|
|
13821
|
-
"
|
|
13822
|
-
"
|
|
13823
|
-
"checks_unavailable"
|
|
13829
|
+
"regeneration_failed",
|
|
13830
|
+
"follow_up_failed",
|
|
13831
|
+
"api_error"
|
|
13824
13832
|
],
|
|
13825
13833
|
"description": "Stable programmatic identifier. Do not branch on message.",
|
|
13826
13834
|
"type": "string"
|
|
@@ -13951,7 +13959,7 @@
|
|
|
13951
13959
|
"method": "GET",
|
|
13952
13960
|
"path": "/publications/{publication_id}",
|
|
13953
13961
|
"summary": "Get publishing status",
|
|
13954
|
-
"description": "Returns the registry publishing status for a release. A status in another organization returns 404
|
|
13962
|
+
"description": "Returns the registry publishing status for a release. A status in another organization returns 404 resource_not_found.",
|
|
13955
13963
|
"safety": "read",
|
|
13956
13964
|
"auth": "required",
|
|
13957
13965
|
"security": [
|
|
@@ -14045,36 +14053,48 @@
|
|
|
14045
14053
|
"properties": {
|
|
14046
14054
|
"type": {
|
|
14047
14055
|
"enum": [
|
|
14048
|
-
"
|
|
14049
|
-
"
|
|
14050
|
-
"
|
|
14051
|
-
"
|
|
14052
|
-
"
|
|
14053
|
-
"
|
|
14054
|
-
"
|
|
14056
|
+
"request",
|
|
14057
|
+
"auth",
|
|
14058
|
+
"idempotency",
|
|
14059
|
+
"rate_limit",
|
|
14060
|
+
"organization",
|
|
14061
|
+
"source",
|
|
14062
|
+
"api"
|
|
14055
14063
|
],
|
|
14056
|
-
"description": "
|
|
14064
|
+
"description": "Who can resolve the error. request: change the request. auth: fix the credential or its grant. idempotency: change or wait on the Idempotency-Key. rate_limit: wait before retrying. organization: the organization's plan must change. source: a system you own failed, such as the Spec URL, repository, or package registry. api: Typeship failed.",
|
|
14057
14065
|
"type": "string"
|
|
14058
14066
|
},
|
|
14059
14067
|
"code": {
|
|
14060
14068
|
"enum": [
|
|
14061
|
-
"
|
|
14069
|
+
"input_invalid",
|
|
14070
|
+
"query_param_invalid",
|
|
14071
|
+
"cursor_invalid",
|
|
14072
|
+
"method_not_allowed",
|
|
14073
|
+
"resource_not_found",
|
|
14074
|
+
"idempotency_key_invalid",
|
|
14062
14075
|
"idempotency_key_reused",
|
|
14063
|
-
"
|
|
14076
|
+
"idempotency_key_in_use",
|
|
14077
|
+
"auth_required",
|
|
14078
|
+
"api_key_invalid",
|
|
14079
|
+
"token_invalid",
|
|
14064
14080
|
"organization_required",
|
|
14065
14081
|
"insufficient_scope",
|
|
14066
|
-
"
|
|
14067
|
-
"
|
|
14068
|
-
"
|
|
14069
|
-
"
|
|
14070
|
-
"
|
|
14082
|
+
"role_insufficient",
|
|
14083
|
+
"rate_limit_exceeded",
|
|
14084
|
+
"plan_limit_reached",
|
|
14085
|
+
"spec_invalid",
|
|
14086
|
+
"spec_too_large",
|
|
14087
|
+
"spec_unreachable",
|
|
14071
14088
|
"repository_provider_unsupported",
|
|
14089
|
+
"repository_disconnected",
|
|
14090
|
+
"repository_unavailable",
|
|
14072
14091
|
"target_busy",
|
|
14092
|
+
"targets_inactive",
|
|
14073
14093
|
"no_draft",
|
|
14074
14094
|
"draft_merged",
|
|
14075
14095
|
"resource_changed",
|
|
14076
|
-
"invalid_version",
|
|
14077
14096
|
"precondition_failed",
|
|
14097
|
+
"version_invalid",
|
|
14078
14098
|
"version_occupied",
|
|
14079
14099
|
"version_too_low",
|
|
14080
14100
|
"target_already_released",
|
|
@@ -14082,15 +14102,12 @@
|
|
|
14082
14102
|
"publication_disabled",
|
|
14083
14103
|
"publication_not_retryable",
|
|
14084
14104
|
"publication_recovery_unavailable",
|
|
14085
|
-
"
|
|
14086
|
-
"repository_disconnected",
|
|
14087
|
-
"regeneration_failed",
|
|
14105
|
+
"publication_failed",
|
|
14088
14106
|
"delivery_conflict",
|
|
14089
14107
|
"resource_has_dependencies",
|
|
14090
|
-
"
|
|
14091
|
-
"
|
|
14092
|
-
"
|
|
14093
|
-
"internal_error",
|
|
14108
|
+
"customization_conflict",
|
|
14109
|
+
"history_recovery_required",
|
|
14110
|
+
"checks_unavailable",
|
|
14094
14111
|
"dependency_missing",
|
|
14095
14112
|
"dependency_not_found",
|
|
14096
14113
|
"dependency_self",
|
|
@@ -14102,10 +14119,9 @@
|
|
|
14102
14119
|
"dependency_module_path_missing",
|
|
14103
14120
|
"dependency_unreleased",
|
|
14104
14121
|
"dependency_revision_mismatch",
|
|
14105
|
-
"
|
|
14106
|
-
"
|
|
14107
|
-
"
|
|
14108
|
-
"checks_unavailable"
|
|
14122
|
+
"regeneration_failed",
|
|
14123
|
+
"follow_up_failed",
|
|
14124
|
+
"api_error"
|
|
14109
14125
|
],
|
|
14110
14126
|
"description": "Stable programmatic identifier. Do not branch on message.",
|
|
14111
14127
|
"type": "string"
|
|
@@ -14273,14 +14289,14 @@
|
|
|
14273
14289
|
"minimum": 1,
|
|
14274
14290
|
"maximum": 100,
|
|
14275
14291
|
"type": "integer",
|
|
14276
|
-
"description": "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
|
|
14292
|
+
"description": "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."
|
|
14277
14293
|
},
|
|
14278
14294
|
"cursor": {
|
|
14279
14295
|
"minLength": 1,
|
|
14280
14296
|
"maxLength": 2048,
|
|
14281
14297
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
14282
14298
|
"type": "string",
|
|
14283
|
-
"description": "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
|
|
14299
|
+
"description": "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."
|
|
14284
14300
|
},
|
|
14285
14301
|
"project_id": {
|
|
14286
14302
|
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
@@ -14490,36 +14506,48 @@
|
|
|
14490
14506
|
"properties": {
|
|
14491
14507
|
"type": {
|
|
14492
14508
|
"enum": [
|
|
14493
|
-
"
|
|
14494
|
-
"
|
|
14495
|
-
"
|
|
14496
|
-
"
|
|
14497
|
-
"
|
|
14498
|
-
"
|
|
14499
|
-
"
|
|
14509
|
+
"request",
|
|
14510
|
+
"auth",
|
|
14511
|
+
"idempotency",
|
|
14512
|
+
"rate_limit",
|
|
14513
|
+
"organization",
|
|
14514
|
+
"source",
|
|
14515
|
+
"api"
|
|
14500
14516
|
],
|
|
14501
|
-
"description": "
|
|
14517
|
+
"description": "Who can resolve the error.",
|
|
14502
14518
|
"type": "string"
|
|
14503
14519
|
},
|
|
14504
14520
|
"code": {
|
|
14505
14521
|
"enum": [
|
|
14506
|
-
"
|
|
14522
|
+
"input_invalid",
|
|
14523
|
+
"query_param_invalid",
|
|
14524
|
+
"cursor_invalid",
|
|
14525
|
+
"method_not_allowed",
|
|
14526
|
+
"resource_not_found",
|
|
14527
|
+
"idempotency_key_invalid",
|
|
14507
14528
|
"idempotency_key_reused",
|
|
14508
|
-
"
|
|
14529
|
+
"idempotency_key_in_use",
|
|
14530
|
+
"auth_required",
|
|
14531
|
+
"api_key_invalid",
|
|
14532
|
+
"token_invalid",
|
|
14509
14533
|
"organization_required",
|
|
14510
14534
|
"insufficient_scope",
|
|
14511
|
-
"
|
|
14512
|
-
"
|
|
14513
|
-
"
|
|
14514
|
-
"
|
|
14515
|
-
"
|
|
14535
|
+
"role_insufficient",
|
|
14536
|
+
"rate_limit_exceeded",
|
|
14537
|
+
"plan_limit_reached",
|
|
14538
|
+
"spec_invalid",
|
|
14539
|
+
"spec_too_large",
|
|
14540
|
+
"spec_unreachable",
|
|
14516
14541
|
"repository_provider_unsupported",
|
|
14542
|
+
"repository_disconnected",
|
|
14543
|
+
"repository_unavailable",
|
|
14517
14544
|
"target_busy",
|
|
14545
|
+
"targets_inactive",
|
|
14518
14546
|
"no_draft",
|
|
14519
14547
|
"draft_merged",
|
|
14520
14548
|
"resource_changed",
|
|
14521
|
-
"invalid_version",
|
|
14522
14549
|
"precondition_failed",
|
|
14550
|
+
"version_invalid",
|
|
14523
14551
|
"version_occupied",
|
|
14524
14552
|
"version_too_low",
|
|
14525
14553
|
"target_already_released",
|
|
@@ -14527,15 +14555,12 @@
|
|
|
14527
14555
|
"publication_disabled",
|
|
14528
14556
|
"publication_not_retryable",
|
|
14529
14557
|
"publication_recovery_unavailable",
|
|
14530
|
-
"
|
|
14531
|
-
"repository_disconnected",
|
|
14532
|
-
"regeneration_failed",
|
|
14558
|
+
"publication_failed",
|
|
14533
14559
|
"delivery_conflict",
|
|
14534
14560
|
"resource_has_dependencies",
|
|
14535
|
-
"
|
|
14536
|
-
"
|
|
14537
|
-
"
|
|
14538
|
-
"internal_error",
|
|
14561
|
+
"customization_conflict",
|
|
14562
|
+
"history_recovery_required",
|
|
14563
|
+
"checks_unavailable",
|
|
14539
14564
|
"dependency_missing",
|
|
14540
14565
|
"dependency_not_found",
|
|
14541
14566
|
"dependency_self",
|
|
@@ -14547,10 +14572,9 @@
|
|
|
14547
14572
|
"dependency_module_path_missing",
|
|
14548
14573
|
"dependency_unreleased",
|
|
14549
14574
|
"dependency_revision_mismatch",
|
|
14550
|
-
"
|
|
14551
|
-
"
|
|
14552
|
-
"
|
|
14553
|
-
"checks_unavailable"
|
|
14575
|
+
"regeneration_failed",
|
|
14576
|
+
"follow_up_failed",
|
|
14577
|
+
"api_error"
|
|
14554
14578
|
],
|
|
14555
14579
|
"description": "Stable programmatic identifier.",
|
|
14556
14580
|
"type": "string"
|
|
@@ -14869,36 +14893,48 @@
|
|
|
14869
14893
|
"properties": {
|
|
14870
14894
|
"type": {
|
|
14871
14895
|
"enum": [
|
|
14872
|
-
"
|
|
14873
|
-
"
|
|
14874
|
-
"
|
|
14875
|
-
"
|
|
14876
|
-
"
|
|
14877
|
-
"
|
|
14878
|
-
"
|
|
14896
|
+
"request",
|
|
14897
|
+
"auth",
|
|
14898
|
+
"idempotency",
|
|
14899
|
+
"rate_limit",
|
|
14900
|
+
"organization",
|
|
14901
|
+
"source",
|
|
14902
|
+
"api"
|
|
14879
14903
|
],
|
|
14880
|
-
"description": "
|
|
14904
|
+
"description": "Who can resolve the error.",
|
|
14881
14905
|
"type": "string"
|
|
14882
14906
|
},
|
|
14883
14907
|
"code": {
|
|
14884
14908
|
"enum": [
|
|
14885
|
-
"
|
|
14909
|
+
"input_invalid",
|
|
14910
|
+
"query_param_invalid",
|
|
14911
|
+
"cursor_invalid",
|
|
14912
|
+
"method_not_allowed",
|
|
14913
|
+
"resource_not_found",
|
|
14914
|
+
"idempotency_key_invalid",
|
|
14886
14915
|
"idempotency_key_reused",
|
|
14887
|
-
"
|
|
14916
|
+
"idempotency_key_in_use",
|
|
14917
|
+
"auth_required",
|
|
14918
|
+
"api_key_invalid",
|
|
14919
|
+
"token_invalid",
|
|
14888
14920
|
"organization_required",
|
|
14889
14921
|
"insufficient_scope",
|
|
14890
|
-
"
|
|
14891
|
-
"
|
|
14892
|
-
"
|
|
14893
|
-
"
|
|
14894
|
-
"
|
|
14922
|
+
"role_insufficient",
|
|
14923
|
+
"rate_limit_exceeded",
|
|
14924
|
+
"plan_limit_reached",
|
|
14925
|
+
"spec_invalid",
|
|
14926
|
+
"spec_too_large",
|
|
14927
|
+
"spec_unreachable",
|
|
14895
14928
|
"repository_provider_unsupported",
|
|
14929
|
+
"repository_disconnected",
|
|
14930
|
+
"repository_unavailable",
|
|
14896
14931
|
"target_busy",
|
|
14932
|
+
"targets_inactive",
|
|
14897
14933
|
"no_draft",
|
|
14898
14934
|
"draft_merged",
|
|
14899
14935
|
"resource_changed",
|
|
14900
|
-
"invalid_version",
|
|
14901
14936
|
"precondition_failed",
|
|
14937
|
+
"version_invalid",
|
|
14902
14938
|
"version_occupied",
|
|
14903
14939
|
"version_too_low",
|
|
14904
14940
|
"target_already_released",
|
|
@@ -14906,15 +14942,12 @@
|
|
|
14906
14942
|
"publication_disabled",
|
|
14907
14943
|
"publication_not_retryable",
|
|
14908
14944
|
"publication_recovery_unavailable",
|
|
14909
|
-
"
|
|
14910
|
-
"repository_disconnected",
|
|
14911
|
-
"regeneration_failed",
|
|
14945
|
+
"publication_failed",
|
|
14912
14946
|
"delivery_conflict",
|
|
14913
14947
|
"resource_has_dependencies",
|
|
14914
|
-
"
|
|
14915
|
-
"
|
|
14916
|
-
"
|
|
14917
|
-
"internal_error",
|
|
14948
|
+
"customization_conflict",
|
|
14949
|
+
"history_recovery_required",
|
|
14950
|
+
"checks_unavailable",
|
|
14918
14951
|
"dependency_missing",
|
|
14919
14952
|
"dependency_not_found",
|
|
14920
14953
|
"dependency_self",
|
|
@@ -14926,10 +14959,9 @@
|
|
|
14926
14959
|
"dependency_module_path_missing",
|
|
14927
14960
|
"dependency_unreleased",
|
|
14928
14961
|
"dependency_revision_mismatch",
|
|
14929
|
-
"
|
|
14930
|
-
"
|
|
14931
|
-
"
|
|
14932
|
-
"checks_unavailable"
|
|
14962
|
+
"regeneration_failed",
|
|
14963
|
+
"follow_up_failed",
|
|
14964
|
+
"api_error"
|
|
14933
14965
|
],
|
|
14934
14966
|
"description": "Stable programmatic identifier.",
|
|
14935
14967
|
"type": "string"
|
|
@@ -15078,14 +15110,14 @@
|
|
|
15078
15110
|
"minimum": 1,
|
|
15079
15111
|
"maximum": 100,
|
|
15080
15112
|
"type": "integer",
|
|
15081
|
-
"description": "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
|
|
15113
|
+
"description": "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."
|
|
15082
15114
|
},
|
|
15083
15115
|
"cursor": {
|
|
15084
15116
|
"minLength": 1,
|
|
15085
15117
|
"maxLength": 2048,
|
|
15086
15118
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
15087
15119
|
"type": "string",
|
|
15088
|
-
"description": "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
|
|
15120
|
+
"description": "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."
|
|
15089
15121
|
}
|
|
15090
15122
|
},
|
|
15091
15123
|
"required": [
|
|
@@ -15441,14 +15473,14 @@
|
|
|
15441
15473
|
"minimum": 1,
|
|
15442
15474
|
"maximum": 100,
|
|
15443
15475
|
"type": "integer",
|
|
15444
|
-
"description": "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
|
|
15476
|
+
"description": "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."
|
|
15445
15477
|
},
|
|
15446
15478
|
"cursor": {
|
|
15447
15479
|
"minLength": 1,
|
|
15448
15480
|
"maxLength": 2048,
|
|
15449
15481
|
"pattern": "^[A-Za-z0-9_-]+$",
|
|
15450
15482
|
"type": "string",
|
|
15451
|
-
"description": "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
|
|
15483
|
+
"description": "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."
|
|
15452
15484
|
}
|
|
15453
15485
|
}
|
|
15454
15486
|
},
|