current-cli 0.1.56__tar.gz → 0.1.57__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.57
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
@@ -5086,6 +5142,53 @@ components:
5086
5142
  - client_secret
5087
5143
  - login_host
5088
5144
  - workspace
5145
+ CloseoutQueueItem:
5146
+ type: object
5147
+ description: One project on a closeout queue page.
5148
+ properties:
5149
+ id:
5150
+ type: string
5151
+ format: uuid
5152
+ name:
5153
+ type: string
5154
+ summary:
5155
+ $ref: '#/components/schemas/CloseoutSummary'
5156
+ required:
5157
+ - id
5158
+ - name
5159
+ - summary
5160
+ CloseoutQueueResponse:
5161
+ type: object
5162
+ description: |-
5163
+ A page of reviewed projects, worst first then longest waiting.
5164
+
5165
+ ``pending`` and ``reviewed`` count the whole workspace rather than the
5166
+ page, because the heading above the list speaks for the backlog and not
5167
+ for what happens to fit on screen. ``next_offset`` is null on the last
5168
+ page.
5169
+ properties:
5170
+ total:
5171
+ type: integer
5172
+ offset:
5173
+ type: integer
5174
+ next_offset:
5175
+ type: integer
5176
+ nullable: true
5177
+ pending:
5178
+ type: integer
5179
+ reviewed:
5180
+ type: integer
5181
+ projects:
5182
+ type: array
5183
+ items:
5184
+ $ref: '#/components/schemas/CloseoutQueueItem'
5185
+ required:
5186
+ - next_offset
5187
+ - offset
5188
+ - pending
5189
+ - projects
5190
+ - reviewed
5191
+ - total
5089
5192
  CloseoutResponse:
5090
5193
  type: object
5091
5194
  description: |-
@@ -5097,6 +5200,59 @@ components:
5097
5200
  nullable: true
5098
5201
  required:
5099
5202
  - review
5203
+ CloseoutSummary:
5204
+ type: object
5205
+ description: |-
5206
+ The compact verdict the closeout queue reads, as
5207
+ ``projects.closeout.build_summary`` writes it.
5208
+
5209
+ Every count is derived from the review document and cached on the
5210
+ project; none of it is stored state a person can edit. ``error`` alone
5211
+ is set when the stored review would not parse, and then the counts are
5212
+ absent — a row that says the review is unreadable is more use than a
5213
+ row that quietly disappears.
5214
+ properties:
5215
+ outcome:
5216
+ type: string
5217
+ nullable: true
5218
+ open_outcome:
5219
+ type: string
5220
+ nullable: true
5221
+ open:
5222
+ type: integer
5223
+ blockers:
5224
+ type: integer
5225
+ majors:
5226
+ type: integer
5227
+ minors:
5228
+ type: integer
5229
+ handled:
5230
+ type: integer
5231
+ satisfied:
5232
+ type: integer
5233
+ requirements_total:
5234
+ type: integer
5235
+ records_clear:
5236
+ type: integer
5237
+ records_total:
5238
+ type: integer
5239
+ blocking_records:
5240
+ type: array
5241
+ items:
5242
+ type: string
5243
+ files:
5244
+ type: integer
5245
+ reviewed_at:
5246
+ type: string
5247
+ nullable: true
5248
+ requirements_version:
5249
+ type: string
5250
+ nullable: true
5251
+ error:
5252
+ type: string
5253
+ nullable: true
5254
+ required:
5255
+ - outcome
5100
5256
  ColorEnum:
5101
5257
  enum:
5102
5258
  - neutral
@@ -5348,10 +5504,12 @@ components:
5348
5504
  enum:
5349
5505
  - activity
5350
5506
  - documents
5507
+ - closeouts
5351
5508
  type: string
5352
5509
  description: |-
5353
5510
  * `activity` - Activity
5354
5511
  * `documents` - Documents
5512
+ * `closeouts` - Closeouts
5355
5513
  DefinitionApplyRequest:
5356
5514
  type: object
5357
5515
  description: |-
@@ -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
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "current-cli"
3
- version = "0.1.56"
3
+ version = "0.1.57"
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