Skip to content

Commit 2a7948f

Browse files
committed
more fixes to swagger
1 parent 0b7347c commit 2a7948f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

public/swagger.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -179,16 +179,18 @@ paths:
179179

180180
/files/{id}:
181181
parameters:
182-
- $ref: '#/components/parameters/id'
182+
- $ref: '#/components/parameters/fileId'
183183
get:
184184
tags:
185185
- files
186186
summary: Download file
187-
description: Can use Chunked transfer encoding if the HTTP header RANGE is set.
187+
description: |
188+
Can use Chunked transfer encoding if the HTTP header RANGE is set.
189+
This function will be reused to actually download the metadata of
190+
the file, please use /files/{id}/blob to get the actual bytes.
188191
responses:
189192
200:
190193
$ref: '#/components/responses/Blob'
191-
deprecated: true
192194
delete:
193195
tags:
194196
- files
@@ -208,7 +210,7 @@ paths:
208210
summary: Download file
209211
description: Can use Chunked transfer encoding if the HTTP header RANGE is set.
210212
parameters:
211-
- $ref: '#/components/parameters/id'
213+
- $ref: '#/components/parameters/fileId'
212214
responses:
213215
200:
214216
$ref: '#/components/responses/Blob'
@@ -224,7 +226,7 @@ paths:
224226
summary: Delete file
225227
description: use DELETE /files/{id} instead
226228
parameters:
227-
- $ref: '#/components/parameters/id'
229+
- $ref: '#/components/parameters/fileId'
228230
responses:
229231
200:
230232
description: OK
@@ -5513,7 +5515,7 @@ components:
55135515
parameters:
55145516
fileId:
55155517
name: id
5516-
in: query
5518+
in: path
55175519
description: ID of file object
55185520
required: true
55195521
schema:

0 commit comments

Comments
 (0)