current-cli 0.1.41__tar.gz → 0.1.43__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.41
3
+ Version: 0.1.43
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
@@ -606,6 +606,56 @@ paths:
606
606
  schema:
607
607
  $ref: '#/components/schemas/FileUrlResponse'
608
608
  description: ''
609
+ /api/files/download-zip/:
610
+ post:
611
+ operationId: files_download_zip
612
+ description: |-
613
+ Zip one or more workspace files, and/or whole folders (given as a
614
+ path ending in "/"), and stream the archive back. See MAX_ZIP_* for
615
+ why this is bounded, unlike the presigned-URL endpoints above.
616
+ tags:
617
+ - files
618
+ requestBody:
619
+ content:
620
+ application/json:
621
+ schema:
622
+ $ref: '#/components/schemas/FileZipRequestRequest'
623
+ application/x-www-form-urlencoded:
624
+ schema:
625
+ $ref: '#/components/schemas/FileZipRequestRequest'
626
+ multipart/form-data:
627
+ schema:
628
+ $ref: '#/components/schemas/FileZipRequestRequest'
629
+ required: true
630
+ security:
631
+ - MessagingJobTokenAuth: []
632
+ - tokenAuth: []
633
+ responses:
634
+ '200':
635
+ content:
636
+ application/zip:
637
+ schema:
638
+ type: string
639
+ format: binary
640
+ description: ''
641
+ '400':
642
+ content:
643
+ application/json:
644
+ schema:
645
+ $ref: '#/components/schemas/FilesErrorDetail'
646
+ description: ''
647
+ '403':
648
+ content:
649
+ application/json:
650
+ schema:
651
+ $ref: '#/components/schemas/FilesErrorDetail'
652
+ description: ''
653
+ '404':
654
+ content:
655
+ application/json:
656
+ schema:
657
+ $ref: '#/components/schemas/FilesErrorDetail'
658
+ description: ''
609
659
  /api/files/upload-url/:
610
660
  post:
611
661
  operationId: files_upload_url
@@ -2043,12 +2093,29 @@ paths:
2043
2093
  Thumbs up/down (+ optional reason and comment) on a piece of platform
2044
2094
  output.
2045
2095
 
2046
- Reads are author-only: a member sees the reactions they gave, and never
2047
- anyone else's. Feedback on the platform's own output is candid only when
2048
- the member knows their colleagues are not reading it, and no surface
2049
- shows another member's reaction. Aggregate sentiment is a reporting
2050
- question, answered off the table directly rather than through this
2051
- endpoint.
2096
+ Reads have two scopes, chosen by the ``scope`` query parameter:
2097
+
2098
+ - ``mine`` (the default) the reactions the caller gave, and nobody
2099
+ else's. This is what a plain member gets, whatever they ask for.
2100
+ - ``workspace`` every member's reactions, restricted to the workspaces
2101
+ the caller is an admin of. A caller who administers no workspace reads
2102
+ nothing under this scope; an admin of one workspace does not thereby
2103
+ read a workspace where they are only a member.
2104
+
2105
+ Author-only is the default rather than the rule because the alternative
2106
+ breaks the caller that exists. The portal reads this endpoint to draw a
2107
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
2108
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
2109
+ current reaction". Widening reads for admins by default would silently
2110
+ make an admin's own widget show whichever teammate reacted last. An
2111
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
2112
+ unchanged and makes reading a colleague's feedback a deliberate act.
2113
+
2114
+ A member is told this: feedback is private from their colleagues, but an
2115
+ admin of their workspace can read it. That is a weaker promise than the
2116
+ one this endpoint shipped with, and it is the honest one — an admin has
2117
+ to be able to see whether the platform's output is any good, and the
2118
+ alternative in practice was reading the production database.
2052
2119
 
2053
2120
  Create for any member of the workspace — every submission is a new row
2054
2121
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -2071,6 +2138,16 @@ paths:
2071
2138
  schema:
2072
2139
  type: string
2073
2140
  description: Filter by project UUID
2141
+ - in: query
2142
+ name: scope
2143
+ schema:
2144
+ type: string
2145
+ enum:
2146
+ - mine
2147
+ - workspace
2148
+ description: Whose reactions to read. 'mine' (the default) reads your own.
2149
+ 'workspace' reads every member's, and returns rows only from the workspaces
2150
+ you are an admin of.
2074
2151
  - in: query
2075
2152
  name: subject_id
2076
2153
  schema:
@@ -2109,12 +2186,29 @@ paths:
2109
2186
  Thumbs up/down (+ optional reason and comment) on a piece of platform
2110
2187
  output.
2111
2188
 
2112
- Reads are author-only: a member sees the reactions they gave, and never
2113
- anyone else's. Feedback on the platform's own output is candid only when
2114
- the member knows their colleagues are not reading it, and no surface
2115
- shows another member's reaction. Aggregate sentiment is a reporting
2116
- question, answered off the table directly rather than through this
2117
- endpoint.
2189
+ Reads have two scopes, chosen by the ``scope`` query parameter:
2190
+
2191
+ - ``mine`` (the default) the reactions the caller gave, and nobody
2192
+ else's. This is what a plain member gets, whatever they ask for.
2193
+ - ``workspace`` every member's reactions, restricted to the workspaces
2194
+ the caller is an admin of. A caller who administers no workspace reads
2195
+ nothing under this scope; an admin of one workspace does not thereby
2196
+ read a workspace where they are only a member.
2197
+
2198
+ Author-only is the default rather than the rule because the alternative
2199
+ breaks the caller that exists. The portal reads this endpoint to draw a
2200
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
2201
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
2202
+ current reaction". Widening reads for admins by default would silently
2203
+ make an admin's own widget show whichever teammate reacted last. An
2204
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
2205
+ unchanged and makes reading a colleague's feedback a deliberate act.
2206
+
2207
+ A member is told this: feedback is private from their colleagues, but an
2208
+ admin of their workspace can read it. That is a weaker promise than the
2209
+ one this endpoint shipped with, and it is the honest one — an admin has
2210
+ to be able to see whether the platform's output is any good, and the
2211
+ alternative in practice was reading the production database.
2118
2212
 
2119
2213
  Create for any member of the workspace — every submission is a new row
2120
2214
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -2150,12 +2244,29 @@ paths:
2150
2244
  Thumbs up/down (+ optional reason and comment) on a piece of platform
2151
2245
  output.
2152
2246
 
2153
- Reads are author-only: a member sees the reactions they gave, and never
2154
- anyone else's. Feedback on the platform's own output is candid only when
2155
- the member knows their colleagues are not reading it, and no surface
2156
- shows another member's reaction. Aggregate sentiment is a reporting
2157
- question, answered off the table directly rather than through this
2158
- endpoint.
2247
+ Reads have two scopes, chosen by the ``scope`` query parameter:
2248
+
2249
+ - ``mine`` (the default) the reactions the caller gave, and nobody
2250
+ else's. This is what a plain member gets, whatever they ask for.
2251
+ - ``workspace`` every member's reactions, restricted to the workspaces
2252
+ the caller is an admin of. A caller who administers no workspace reads
2253
+ nothing under this scope; an admin of one workspace does not thereby
2254
+ read a workspace where they are only a member.
2255
+
2256
+ Author-only is the default rather than the rule because the alternative
2257
+ breaks the caller that exists. The portal reads this endpoint to draw a
2258
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
2259
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
2260
+ current reaction". Widening reads for admins by default would silently
2261
+ make an admin's own widget show whichever teammate reacted last. An
2262
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
2263
+ unchanged and makes reading a colleague's feedback a deliberate act.
2264
+
2265
+ A member is told this: feedback is private from their colleagues, but an
2266
+ admin of their workspace can read it. That is a weaker promise than the
2267
+ one this endpoint shipped with, and it is the honest one — an admin has
2268
+ to be able to see whether the platform's output is any good, and the
2269
+ alternative in practice was reading the production database.
2159
2270
 
2160
2271
  Create for any member of the workspace — every submission is a new row
2161
2272
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -2168,6 +2279,16 @@ paths:
2168
2279
  format: uuid
2169
2280
  description: A UUID string identifying this reaction.
2170
2281
  required: true
2282
+ - in: query
2283
+ name: scope
2284
+ schema:
2285
+ type: string
2286
+ enum:
2287
+ - mine
2288
+ - workspace
2289
+ description: Whose reactions to read. 'mine' (the default) reads your own.
2290
+ 'workspace' reads every member's, and returns rows only from the workspaces
2291
+ you are an admin of.
2171
2292
  tags:
2172
2293
  - reactions
2173
2294
  security:
@@ -4279,6 +4400,33 @@ components:
4279
4400
  required:
4280
4401
  - path
4281
4402
  - url
4403
+ FileZipRequestRequest:
4404
+ type: object
4405
+ properties:
4406
+ workspace:
4407
+ type: string
4408
+ format: uuid
4409
+ paths:
4410
+ type: array
4411
+ items:
4412
+ type: string
4413
+ minLength: 1
4414
+ maxLength: 1024
4415
+ maxItems: 200
4416
+ minItems: 1
4417
+ filename:
4418
+ type: string
4419
+ maxLength: 200
4420
+ required:
4421
+ - paths
4422
+ - workspace
4423
+ FilesErrorDetail:
4424
+ type: object
4425
+ properties:
4426
+ detail:
4427
+ type: string
4428
+ required:
4429
+ - detail
4282
4430
  InboxRoleEnum:
4283
4431
  enum:
4284
4432
  - interaction
@@ -224,6 +224,17 @@ POST /api/files/download-url/
224
224
  Options:
225
225
  - `--data` (required) - Request body as JSON: inline, @file.json, or - for stdin.
226
226
 
227
+ ### current files download-zip post
228
+
229
+ Zip one or more workspace files, and/or whole folders (given as a
230
+ path ending in "/"), and stream the archive back. See MAX_ZIP_* for
231
+ why this is bounded, unlike the presigned-URL endpoints above.
232
+
233
+ POST /api/files/download-zip/
234
+
235
+ Options:
236
+ - `--data` (required) - Request body as JSON: inline, @file.json, or - for stdin.
237
+
227
238
  ### current files list
228
239
 
229
240
  GET /api/files/
@@ -747,12 +758,29 @@ Options:
747
758
  Thumbs up/down (+ optional reason and comment) on a piece of platform
748
759
  output.
749
760
 
750
- Reads are author-only: a member sees the reactions they gave, and never
751
- anyone else's. Feedback on the platform's own output is candid only when
752
- the member knows their colleagues are not reading it, and no surface
753
- shows another member's reaction. Aggregate sentiment is a reporting
754
- question, answered off the table directly rather than through this
755
- endpoint.
761
+ Reads have two scopes, chosen by the ``scope`` query parameter:
762
+
763
+ - ``mine`` (the default) the reactions the caller gave, and nobody
764
+ else's. This is what a plain member gets, whatever they ask for.
765
+ - ``workspace`` every member's reactions, restricted to the workspaces
766
+ the caller is an admin of. A caller who administers no workspace reads
767
+ nothing under this scope; an admin of one workspace does not thereby
768
+ read a workspace where they are only a member.
769
+
770
+ Author-only is the default rather than the rule because the alternative
771
+ breaks the caller that exists. The portal reads this endpoint to draw a
772
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
773
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
774
+ current reaction". Widening reads for admins by default would silently
775
+ make an admin's own widget show whichever teammate reacted last. An
776
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
777
+ unchanged and makes reading a colleague's feedback a deliberate act.
778
+
779
+ A member is told this: feedback is private from their colleagues, but an
780
+ admin of their workspace can read it. That is a weaker promise than the
781
+ one this endpoint shipped with, and it is the honest one — an admin has
782
+ to be able to see whether the platform's output is any good, and the
783
+ alternative in practice was reading the production database.
756
784
 
757
785
  Create for any member of the workspace — every submission is a new row
758
786
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -768,12 +796,29 @@ Options:
768
796
  Thumbs up/down (+ optional reason and comment) on a piece of platform
769
797
  output.
770
798
 
771
- Reads are author-only: a member sees the reactions they gave, and never
772
- anyone else's. Feedback on the platform's own output is candid only when
773
- the member knows their colleagues are not reading it, and no surface
774
- shows another member's reaction. Aggregate sentiment is a reporting
775
- question, answered off the table directly rather than through this
776
- endpoint.
799
+ Reads have two scopes, chosen by the ``scope`` query parameter:
800
+
801
+ - ``mine`` (the default) the reactions the caller gave, and nobody
802
+ else's. This is what a plain member gets, whatever they ask for.
803
+ - ``workspace`` every member's reactions, restricted to the workspaces
804
+ the caller is an admin of. A caller who administers no workspace reads
805
+ nothing under this scope; an admin of one workspace does not thereby
806
+ read a workspace where they are only a member.
807
+
808
+ Author-only is the default rather than the rule because the alternative
809
+ breaks the caller that exists. The portal reads this endpoint to draw a
810
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
811
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
812
+ current reaction". Widening reads for admins by default would silently
813
+ make an admin's own widget show whichever teammate reacted last. An
814
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
815
+ unchanged and makes reading a colleague's feedback a deliberate act.
816
+
817
+ A member is told this: feedback is private from their colleagues, but an
818
+ admin of their workspace can read it. That is a weaker promise than the
819
+ one this endpoint shipped with, and it is the honest one — an admin has
820
+ to be able to see whether the platform's output is any good, and the
821
+ alternative in practice was reading the production database.
777
822
 
778
823
  Create for any member of the workspace — every submission is a new row
779
824
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -785,6 +830,7 @@ Options:
785
830
  - `--limit` - Number of results to return per page.
786
831
  - `--offset` - The initial index from which to return the results.
787
832
  - `--project` - Filter by project UUID
833
+ - `--scope` - Whose reactions to read. 'mine' (the default) reads your own. 'workspace' reads every member's, and returns rows only from the workspaces you are an admin of.
788
834
  - `--subject-id` - Filter by subject id
789
835
  - `--subject-type` - Filter by subject type
790
836
  - `--subject-version` - Filter by subject version
@@ -795,12 +841,29 @@ Options:
795
841
  Thumbs up/down (+ optional reason and comment) on a piece of platform
796
842
  output.
797
843
 
798
- Reads are author-only: a member sees the reactions they gave, and never
799
- anyone else's. Feedback on the platform's own output is candid only when
800
- the member knows their colleagues are not reading it, and no surface
801
- shows another member's reaction. Aggregate sentiment is a reporting
802
- question, answered off the table directly rather than through this
803
- endpoint.
844
+ Reads have two scopes, chosen by the ``scope`` query parameter:
845
+
846
+ - ``mine`` (the default) the reactions the caller gave, and nobody
847
+ else's. This is what a plain member gets, whatever they ask for.
848
+ - ``workspace`` every member's reactions, restricted to the workspaces
849
+ the caller is an admin of. A caller who administers no workspace reads
850
+ nothing under this scope; an admin of one workspace does not thereby
851
+ read a workspace where they are only a member.
852
+
853
+ Author-only is the default rather than the rule because the alternative
854
+ breaks the caller that exists. The portal reads this endpoint to draw a
855
+ member's own thumb (``getMyReaction``/``getMyReactions`` in
856
+ ``reactionsLogic.ts``) and takes the first row for a subject as "my
857
+ current reaction". Widening reads for admins by default would silently
858
+ make an admin's own widget show whichever teammate reacted last. An
859
+ explicit ``scope=workspace`` keeps that call path byte-for-byte
860
+ unchanged and makes reading a colleague's feedback a deliberate act.
861
+
862
+ A member is told this: feedback is private from their colleagues, but an
863
+ admin of their workspace can read it. That is a weaker promise than the
864
+ one this endpoint shipped with, and it is the honest one — an admin has
865
+ to be able to see whether the platform's output is any good, and the
866
+ alternative in practice was reading the production database.
804
867
 
805
868
  Create for any member of the workspace — every submission is a new row
806
869
  (see ``Reaction``). No update or delete: a changed mind is a new
@@ -808,6 +871,9 @@ reaction, not an edit to the old one.
808
871
 
809
872
  GET /api/reactions/reactions/{id}/
810
873
 
874
+ Options:
875
+ - `--scope` - Whose reactions to read. 'mine' (the default) reads your own. 'workspace' reads every member's, and returns rows only from the workspaces you are an admin of.
876
+
811
877
  ### current tasks create
812
878
 
813
879
  The caller's personal todos. Incomplete tasks sort before completed ones.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "current-cli"
3
- version = "0.1.41"
3
+ version = "0.1.43"
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