Skip to content

Commit 57d3c95

Browse files
paulineribeyrepaulineribeyre
committed
update docs
1 parent 189271e commit 57d3c95

File tree

2 files changed

+50
-50
lines changed

2 files changed

+50
-50
lines changed

‎docs/openapi.yaml‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,10 @@ paths:
184184
CLI.
185185
186186
187-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
188-
clients like Minio do
187+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
188+
S3 clients that do
189189
190-
not support S3 endpoints with a path.'
190+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
191191
operationId: s3_endpoint
192192
parameters:
193193
- in: path
@@ -222,10 +222,10 @@ paths:
222222
CLI.
223223
224224
225-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
226-
clients like Minio do
225+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
226+
S3 clients that do
227227
228-
not support S3 endpoints with a path.'
228+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
229229
operationId: s3_endpoint
230230
parameters:
231231
- in: path
@@ -260,10 +260,10 @@ paths:
260260
CLI.
261261
262262
263-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
264-
clients like Minio do
263+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
264+
S3 clients that do
265265
266-
not support S3 endpoints with a path.'
266+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
267267
operationId: s3_endpoint
268268
parameters:
269269
- in: path
@@ -298,10 +298,10 @@ paths:
298298
CLI.
299299
300300
301-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
302-
clients like Minio do
301+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
302+
S3 clients that do
303303
304-
not support S3 endpoints with a path.'
304+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
305305
operationId: s3_endpoint
306306
parameters:
307307
- in: path
@@ -336,10 +336,10 @@ paths:
336336
CLI.
337337
338338
339-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
340-
clients like Minio do
339+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
340+
S3 clients that do
341341
342-
not support S3 endpoints with a path.'
342+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
343343
operationId: s3_endpoint
344344
parameters:
345345
- in: path
@@ -374,10 +374,10 @@ paths:
374374
CLI.
375375
376376
377-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
378-
clients like Minio do
377+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
378+
S3 clients that do
379379
380-
not support S3 endpoints with a path.'
380+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
381381
operationId: s3_endpoint
382382
parameters:
383383
- in: path
@@ -412,10 +412,10 @@ paths:
412412
CLI.
413413
414414
415-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
416-
clients like Minio do
415+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
416+
S3 clients that do
417417
418-
not support S3 endpoints with a path.'
418+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
419419
operationId: s3_endpoint
420420
parameters:
421421
- in: path
@@ -450,10 +450,10 @@ paths:
450450
CLI.
451451
452452
453-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
454-
clients like Minio do
453+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
454+
S3 clients that do
455455
456-
not support S3 endpoints with a path.'
456+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
457457
operationId: s3_endpoint
458458
parameters:
459459
- in: path
@@ -516,10 +516,10 @@ paths:
516516
CLI.
517517
518518
519-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
520-
clients like Minio do
519+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
520+
S3 clients that do
521521
522-
not support S3 endpoints with a path.'
522+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
523523
operationId: s3_endpoint_2
524524
parameters:
525525
- in: path
@@ -554,10 +554,10 @@ paths:
554554
CLI.
555555
556556
557-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
558-
clients like Minio do
557+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
558+
S3 clients that do
559559
560-
not support S3 endpoints with a path.'
560+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
561561
operationId: s3_endpoint_2
562562
parameters:
563563
- in: path
@@ -592,10 +592,10 @@ paths:
592592
CLI.
593593
594594
595-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
596-
clients like Minio do
595+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
596+
S3 clients that do
597597
598-
not support S3 endpoints with a path.'
598+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
599599
operationId: s3_endpoint_2
600600
parameters:
601601
- in: path
@@ -630,10 +630,10 @@ paths:
630630
CLI.
631631
632632
633-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
634-
clients like Minio do
633+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
634+
S3 clients that do
635635
636-
not support S3 endpoints with a path.'
636+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
637637
operationId: s3_endpoint_2
638638
parameters:
639639
- in: path
@@ -668,10 +668,10 @@ paths:
668668
CLI.
669669
670670
671-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
672-
clients like Minio do
671+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
672+
S3 clients that do
673673
674-
not support S3 endpoints with a path.'
674+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
675675
operationId: s3_endpoint_2
676676
parameters:
677677
- in: path
@@ -706,10 +706,10 @@ paths:
706706
CLI.
707707
708708
709-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
710-
clients like Minio do
709+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
710+
S3 clients that do
711711
712-
not support S3 endpoints with a path.'
712+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
713713
operationId: s3_endpoint_2
714714
parameters:
715715
- in: path
@@ -744,10 +744,10 @@ paths:
744744
CLI.
745745
746746
747-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
748-
clients like Minio do
747+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
748+
S3 clients that do
749749
750-
not support S3 endpoints with a path.'
750+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
751751
operationId: s3_endpoint_2
752752
parameters:
753753
- in: path
@@ -782,10 +782,10 @@ paths:
782782
CLI.
783783
784784
785-
The S3 endpoint is exposed at `/s3` as well as it the root `/` because S3
786-
clients like Minio do
785+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support
786+
S3 clients that do
787787
788-
not support S3 endpoints with a path.'
788+
not support S3 endpoints with a path, such as the Minio-go S3 client.'
789789
operationId: s3_endpoint_2
790790
parameters:
791791
- in: path

‎gen3workflow/routes/s3.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ async def s3_endpoint(path: str, request: Request):
9999
appropriate credentials to access the current user's AWS S3 bucket, and forward them to
100100
AWS S3. The recommended way to use this endpoint is to use the AWS SDK or CLI.
101101
102-
The S3 endpoint is exposed at `/s3` as well as at the root `/` because S3 clients like Minio do
103-
not support S3 endpoints with a path.
102+
The S3 endpoint is exposed at `/s3` as well as at the root `/` to support S3 clients that do
103+
not support S3 endpoints with a path, such as the Minio-go S3 client.
104104
"""
105105

106106
# because this endpoint is exposed at root, if the path is empty, assume the user is not trying

0 commit comments

Comments
 (0)