1
0
mirror of https://github.com/sasjs/server.git synced 2025-12-11 03:34:35 +00:00

chore: added some docs to file upload

This commit is contained in:
Saad Jutt
2022-02-28 22:54:49 +05:00
parent feeec4eb14
commit 5fce7d8f71
2 changed files with 9 additions and 0 deletions

View File

@@ -663,6 +663,7 @@ paths:
examples: examples:
'Example 1': 'Example 1':
value: {status: failure, message: 'File request failed.'} value: {status: failure, message: 'File request failed.'}
description: "It's optional to either provide `_filePath` in url as query parameter\nOr provide `filePath` in body as form field.\nBut it's required to provided else API will respond with Bad Request."
summary: 'Create a file in SASjs Drive' summary: 'Create a file in SASjs Drive'
tags: tags:
- Drive - Drive
@@ -671,11 +672,13 @@ paths:
bearerAuth: [] bearerAuth: []
parameters: parameters:
- -
description: 'Location of SAS program'
in: query in: query
name: _filePath name: _filePath
required: false required: false
schema: schema:
type: string type: string
example: /Public/somefolder/some.file.sas
requestBody: requestBody:
required: true required: true
content: content:

View File

@@ -117,7 +117,13 @@ export class DriveController {
} }
/** /**
* It's optional to either provide `_filePath` in url as query parameter
* Or provide `filePath` in body as form field.
* But it's required to provided else API will respond with Bad Request.
*
* @summary Create a file in SASjs Drive * @summary Create a file in SASjs Drive
* @param _filePath Location of SAS program
* @example _filePath "/Public/somefolder/some.file.sas"
* *
*/ */
@Example<UpdateFileResponse>({ @Example<UpdateFileResponse>({