Files by URL reference
You can upload and download files using a URL reference.
How to upload and download files by URL reference
In the parameter, object property or response object that represents the file, add:
- A type property of string.
- A format property of x-ntx-file-reference.
Where to use file URL references
You can use file URL references:
- In a parameter object to upload a file.
-
In a property of an object within a parameter to upload a file.
- In the response object to download a file.
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "x-ntx-file-reference"
}
}
}
}