current-cli 0.1.56__tar.gz → 0.1.58__tar.gz

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: current-cli
3
- Version: 0.1.56
3
+ Version: 0.1.58
4
4
  Summary: Command line interface for the Current API, generated from its OpenAPI schema at runtime
5
5
  Author-email: Orin <your-email@example.com>
6
6
  License-Expression: MIT
@@ -2252,6 +2252,62 @@ paths:
2252
2252
  schema:
2253
2253
  $ref: '#/components/schemas/Project'
2254
2254
  description: ''
2255
+ /api/projects/projects/closeouts/:
2256
+ get:
2257
+ operationId: projects_projects_closeouts_retrieve
2258
+ description: |-
2259
+ Every project in the workspace that has a closeout review, worst
2260
+ first then longest waiting.
2261
+
2262
+ Reads the cached summary on each project rather than the review
2263
+ document itself, so one page is one query instead of one storage
2264
+ read per row. The report still reads the document, which is why an
2265
+ opened review is never stale even when this list is.
2266
+ parameters:
2267
+ - in: query
2268
+ name: limit
2269
+ schema:
2270
+ type: integer
2271
+ description: Max projects per page (default 50, max 200)
2272
+ - in: query
2273
+ name: offset
2274
+ schema:
2275
+ type: integer
2276
+ description: Number of projects to skip (default 0)
2277
+ - in: query
2278
+ name: q
2279
+ schema:
2280
+ type: string
2281
+ description: Keep only projects whose name contains this text, ignoring case
2282
+ - in: query
2283
+ name: status
2284
+ schema:
2285
+ type: string
2286
+ enum:
2287
+ - all
2288
+ - clear
2289
+ - pending
2290
+ description: 'Which reviewed projects to keep: ''pending'' (default) for the
2291
+ ones asking something of a person, ''clear'' for the rest, ''all'' for both.
2292
+ A project with no closeout review is absent at every status.'
2293
+ - in: query
2294
+ name: workspace
2295
+ schema:
2296
+ type: string
2297
+ description: Workspace UUID
2298
+ required: true
2299
+ tags:
2300
+ - projects
2301
+ security:
2302
+ - MessagingJobTokenAuth: []
2303
+ - tokenAuth: []
2304
+ responses:
2305
+ '200':
2306
+ content:
2307
+ application/json:
2308
+ schema:
2309
+ $ref: '#/components/schemas/CloseoutQueueResponse'
2310
+ description: ''
2255
2311
  /api/projects/projects/inventory/:
2256
2312
  get:
2257
2313
  operationId: projects_projects_inventory_retrieve
@@ -4081,6 +4137,41 @@ paths:
4081
4137
  schema:
4082
4138
  $ref: '#/components/schemas/RunDefinition'
4083
4139
  description: ''
4140
+ /api/workflows/runs/{run_id}/files/delete/:
4141
+ post:
4142
+ operationId: run_files_delete
4143
+ description: |-
4144
+ Remove superseded generated PDFs from this run's project.
4145
+
4146
+ This endpoint is intentionally narrower than the member-facing file
4147
+ deletion API. A workflow can remove only a draft PDF in its own project's
4148
+ ``po/`` directory, and bucket versioning keeps the operation recoverable.
4149
+ parameters:
4150
+ - in: path
4151
+ name: run_id
4152
+ schema:
4153
+ type: string
4154
+ format: uuid
4155
+ required: true
4156
+ tags:
4157
+ - workflows
4158
+ requestBody:
4159
+ content:
4160
+ application/json:
4161
+ schema:
4162
+ $ref: '#/components/schemas/DeleteRequestRequest'
4163
+ application/x-www-form-urlencoded:
4164
+ schema:
4165
+ $ref: '#/components/schemas/DeleteRequestRequest'
4166
+ multipart/form-data:
4167
+ schema:
4168
+ $ref: '#/components/schemas/DeleteRequestRequest'
4169
+ required: true
4170
+ security:
4171
+ - RunTokenAuth: []
4172
+ responses:
4173
+ '204':
4174
+ description: No response body
4084
4175
  /api/workflows/runs/{run_id}/files/manifest/:
4085
4176
  get:
4086
4177
  operationId: run_files_manifest
@@ -5086,6 +5177,53 @@ components:
5086
5177
  - client_secret
5087
5178
  - login_host
5088
5179
  - workspace
5180
+ CloseoutQueueItem:
5181
+ type: object
5182
+ description: One project on a closeout queue page.
5183
+ properties:
5184
+ id:
5185
+ type: string
5186
+ format: uuid
5187
+ name:
5188
+ type: string
5189
+ summary:
5190
+ $ref: '#/components/schemas/CloseoutSummary'
5191
+ required:
5192
+ - id
5193
+ - name
5194
+ - summary
5195
+ CloseoutQueueResponse:
5196
+ type: object
5197
+ description: |-
5198
+ A page of reviewed projects, worst first then longest waiting.
5199
+
5200
+ ``pending`` and ``reviewed`` count the whole workspace rather than the
5201
+ page, because the heading above the list speaks for the backlog and not
5202
+ for what happens to fit on screen. ``next_offset`` is null on the last
5203
+ page.
5204
+ properties:
5205
+ total:
5206
+ type: integer
5207
+ offset:
5208
+ type: integer
5209
+ next_offset:
5210
+ type: integer
5211
+ nullable: true
5212
+ pending:
5213
+ type: integer
5214
+ reviewed:
5215
+ type: integer
5216
+ projects:
5217
+ type: array
5218
+ items:
5219
+ $ref: '#/components/schemas/CloseoutQueueItem'
5220
+ required:
5221
+ - next_offset
5222
+ - offset
5223
+ - pending
5224
+ - projects
5225
+ - reviewed
5226
+ - total
5089
5227
  CloseoutResponse:
5090
5228
  type: object
5091
5229
  description: |-
@@ -5097,6 +5235,59 @@ components:
5097
5235
  nullable: true
5098
5236
  required:
5099
5237
  - review
5238
+ CloseoutSummary:
5239
+ type: object
5240
+ description: |-
5241
+ The compact verdict the closeout queue reads, as
5242
+ ``projects.closeout.build_summary`` writes it.
5243
+
5244
+ Every count is derived from the review document and cached on the
5245
+ project; none of it is stored state a person can edit. ``error`` alone
5246
+ is set when the stored review would not parse, and then the counts are
5247
+ absent — a row that says the review is unreadable is more use than a
5248
+ row that quietly disappears.
5249
+ properties:
5250
+ outcome:
5251
+ type: string
5252
+ nullable: true
5253
+ open_outcome:
5254
+ type: string
5255
+ nullable: true
5256
+ open:
5257
+ type: integer
5258
+ blockers:
5259
+ type: integer
5260
+ majors:
5261
+ type: integer
5262
+ minors:
5263
+ type: integer
5264
+ handled:
5265
+ type: integer
5266
+ satisfied:
5267
+ type: integer
5268
+ requirements_total:
5269
+ type: integer
5270
+ records_clear:
5271
+ type: integer
5272
+ records_total:
5273
+ type: integer
5274
+ blocking_records:
5275
+ type: array
5276
+ items:
5277
+ type: string
5278
+ files:
5279
+ type: integer
5280
+ reviewed_at:
5281
+ type: string
5282
+ nullable: true
5283
+ requirements_version:
5284
+ type: string
5285
+ nullable: true
5286
+ error:
5287
+ type: string
5288
+ nullable: true
5289
+ required:
5290
+ - outcome
5100
5291
  ColorEnum:
5101
5292
  enum:
5102
5293
  - neutral
@@ -5348,10 +5539,12 @@ components:
5348
5539
  enum:
5349
5540
  - activity
5350
5541
  - documents
5542
+ - closeouts
5351
5543
  type: string
5352
5544
  description: |-
5353
5545
  * `activity` - Activity
5354
5546
  * `documents` - Documents
5547
+ * `closeouts` - Closeouts
5355
5548
  DefinitionApplyRequest:
5356
5549
  type: object
5357
5550
  description: |-
@@ -5363,6 +5556,18 @@ components:
5363
5556
  format: uuid
5364
5557
  required:
5365
5558
  - workspace
5559
+ DeleteRequestRequest:
5560
+ type: object
5561
+ properties:
5562
+ paths:
5563
+ type: array
5564
+ items:
5565
+ type: string
5566
+ minLength: 1
5567
+ maxLength: 1024
5568
+ maxItems: 100
5569
+ required:
5570
+ - paths
5366
5571
  DetailResponse:
5367
5572
  type: object
5368
5573
  properties:
@@ -7520,8 +7725,9 @@ components:
7520
7725
  Body of the machine completion endpoint — the runner's terminal
7521
7726
  report. ``finished_at`` is an RFC 3339 string; a naive value is made
7522
7727
  aware (UTC) rather than reaching the column unlabelled. ``summary``
7523
- becomes the run's terminal summary; ``error`` populates ``run.error``
7524
- (a failed run with no error gets a fixed sentence).
7728
+ becomes the run's terminal summary; ``result`` carries declared artifacts
7729
+ and review context; ``error`` populates ``run.error`` (a failed run with
7730
+ no error gets a fixed sentence).
7525
7731
  properties:
7526
7732
  status:
7527
7733
  $ref: '#/components/schemas/RunCompleteStatusEnum'
@@ -7538,6 +7744,7 @@ components:
7538
7744
  type: string
7539
7745
  nullable: true
7540
7746
  default: ''
7747
+ result: {}
7541
7748
  required:
7542
7749
  - status
7543
7750
  RunCompleteResponse:
@@ -8544,6 +8751,8 @@ components:
8544
8751
  items:
8545
8752
  $ref: '#/components/schemas/StepTransition'
8546
8753
  readOnly: true
8754
+ result:
8755
+ readOnly: true
8547
8756
  trigger:
8548
8757
  allOf:
8549
8758
  - $ref: '#/components/schemas/RunTrigger'
@@ -8568,6 +8777,7 @@ components:
8568
8777
  - id
8569
8778
  - project
8570
8779
  - project_name
8780
+ - result
8571
8781
  - sandbox_id
8572
8782
  - started_at
8573
8783
  - status
@@ -657,6 +657,25 @@ one yet.
657
657
 
658
658
  GET /api/projects/projects/{id}/closeout/
659
659
 
660
+ ### current projects closeouts retrieve
661
+
662
+ Every project in the workspace that has a closeout review, worst
663
+ first then longest waiting.
664
+
665
+ Reads the cached summary on each project rather than the review
666
+ document itself, so one page is one query instead of one storage
667
+ read per row. The report still reads the document, which is why an
668
+ opened review is never stale even when this list is.
669
+
670
+ GET /api/projects/projects/closeouts/
671
+
672
+ Options:
673
+ - `--limit` - Max projects per page (default 50, max 200)
674
+ - `--offset` - Number of projects to skip (default 0)
675
+ - `--q` - Keep only projects whose name contains this text, ignoring case
676
+ - `--status` - Which reviewed projects to keep: 'pending' (default) for the ones asking something of a person, 'clear' for the rest, 'all' for both. A project with no closeout review is absent at every status.
677
+ - `--workspace` - Workspace UUID
678
+
660
679
  ### current projects create
661
680
 
662
681
  Projects across the caller's workspaces. Any member can create a
@@ -1359,6 +1378,19 @@ definition plus the journal state it needs to resume (step states).
1359
1378
 
1360
1379
  GET /api/workflows/runs/{run_id}/definition/
1361
1380
 
1381
+ ### current workflows runs files delete post <run_id>
1382
+
1383
+ Remove superseded generated PDFs from this run's project.
1384
+
1385
+ This endpoint is intentionally narrower than the member-facing file
1386
+ deletion API. A workflow can remove only a draft PDF in its own project's
1387
+ ``po/`` directory, and bucket versioning keeps the operation recoverable.
1388
+
1389
+ POST /api/workflows/runs/{run_id}/files/delete/
1390
+
1391
+ Options:
1392
+ - `--data` (required) - Request body as JSON: inline, @file.json, or - for stdin.
1393
+
1362
1394
  ### current workflows runs files manifest get <run_id>
1363
1395
 
1364
1396
  GET /api/workflows/runs/{run_id}/files/manifest/
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "current-cli"
3
- version = "0.1.56"
3
+ version = "0.1.58"
4
4
  description = "Command line interface for the Current API, generated from its OpenAPI schema at runtime"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.10"
File without changes
File without changes