Document the optional parameter for specifying a filename to download an attachment as
This commit is contained in:
parent
4f206e3223
commit
618f94699b
1 changed files with 40 additions and 0 deletions
|
@ -96,6 +96,46 @@ paths:
|
||||||
type: file
|
type: file
|
||||||
tags:
|
tags:
|
||||||
- Media
|
- Media
|
||||||
|
"/download/{serverName}/{mediaId}/{fileName}"
|
||||||
|
get:
|
||||||
|
summary: "Download content from the content repository as a given filename."
|
||||||
|
produces: ["*/*"]
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: serverName
|
||||||
|
x-example: matrix.org
|
||||||
|
required: true
|
||||||
|
description: |
|
||||||
|
The server name from the ``mxc://`` URI (the authoritory component)
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: mediaId
|
||||||
|
x-example: ascERGshawAWawugaAcauga
|
||||||
|
required: true
|
||||||
|
description: |
|
||||||
|
The media ID from the ``mxc://`` URI (the path component)
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: fileName
|
||||||
|
x-example: filename.jpg
|
||||||
|
requrired: true
|
||||||
|
description:
|
||||||
|
The filename to give in the Content-Disposition
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: "The content that was previously uploaded."
|
||||||
|
headers:
|
||||||
|
Content-Type:
|
||||||
|
description: "The content type of the file that was previously uploaded."
|
||||||
|
type: "string"
|
||||||
|
Content-Disposition:
|
||||||
|
description: "The name of file given in the request"
|
||||||
|
type: "string"
|
||||||
|
schema:
|
||||||
|
type: file
|
||||||
|
tags:
|
||||||
|
- Media
|
||||||
"/thumbnail/{serverName}/{mediaId}":
|
"/thumbnail/{serverName}/{mediaId}":
|
||||||
get:
|
get:
|
||||||
summary: "Download a thumbnail of the content from the content repository."
|
summary: "Download a thumbnail of the content from the content repository."
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue