diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml index 5bd8ca1..6bbb31a 100644 --- a/api/public/swagger.yaml +++ b/api/public/swagger.yaml @@ -663,7 +663,7 @@ paths: description: 'Execute SAS code.' summary: 'Run SAS Code and returns log' tags: - - CODE + - Code security: - bearerAuth: [] @@ -1658,8 +1658,8 @@ paths: anyOf: - {type: string} - {type: string, format: byte} - description: "Trigger a SAS or JS program using the _program URL parameter.\n\nAccepts URL parameters and file uploads. For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms" - summary: 'Execute a Stored Program, returns raw _webout content.' + description: "Trigger a Stored Program using the _program URL parameter.\n\nAccepts URL parameters and file uploads. For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms" + summary: 'Execute a Stored Program, returns _webout and (optionally) log.' tags: - STP security: @@ -1667,7 +1667,7 @@ paths: bearerAuth: [] parameters: - - description: 'Location of SAS or JS code' + description: 'Location of code in SASjs Drive' in: query name: _program required: true @@ -1685,7 +1685,7 @@ paths: anyOf: - {type: string} - {type: string, format: byte} - description: "Trigger a SAS or JS program using the _program URL parameter.\n\nAccepts URL parameters and file uploads. For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms\n\nThe response will be a JSON object with the following root attributes:\nlog, webout, headers.\n\nThe webout attribute will be nested JSON ONLY if the response-header\ncontains a content-type of application/json AND it is valid JSON.\nOtherwise it will be a stringified version of the webout content." + description: "Trigger a Stored Program using the _program URL parameter.\n\nAccepts URL parameters and file uploads. For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms" summary: 'Execute a Stored Program, return a JSON object' tags: - STP @@ -1694,7 +1694,7 @@ paths: bearerAuth: [] parameters: - - description: 'Location of SAS or JS code' + description: 'Location of code in SASjs Drive' in: query name: _program required: false @@ -1798,7 +1798,7 @@ tags: name: Client description: 'Operations about clients' - - name: CODE + name: Code description: 'Execution of code (various runtimes are supported)' - name: Drive diff --git a/api/src/controllers/code.ts b/api/src/controllers/code.ts index b164396..68f8c52 100644 --- a/api/src/controllers/code.ts +++ b/api/src/controllers/code.ts @@ -24,7 +24,7 @@ interface ExecuteCodePayload { @Security('bearerAuth') @Route('SASjsApi/code') -@Tags('CODE') +@Tags('Code') export class CodeController { /** * Execute SAS code. diff --git a/api/src/controllers/stp.ts b/api/src/controllers/stp.ts index aab271a..335d53a 100644 --- a/api/src/controllers/stp.ts +++ b/api/src/controllers/stp.ts @@ -23,14 +23,14 @@ interface ExecutePostRequestPayload { @Tags('STP') export class STPController { /** - * Trigger a SAS or JS program using the _program URL parameter. + * Trigger a Stored Program using the _program URL parameter. * * Accepts URL parameters and file uploads. For more details, see docs: * * https://server.sasjs.io/storedprograms * - * @summary Execute a Stored Program, returns raw _webout content. - * @param _program Location of SAS or JS code + * @summary Execute a Stored Program, returns _webout and (optionally) log. + * @param _program Location of code in SASjs Drive * @example _program "/Projects/myApp/some/program" */ @Get('/execute') @@ -43,21 +43,15 @@ export class STPController { } /** - * Trigger a SAS or JS program using the _program URL parameter. + * Trigger a Stored Program using the _program URL parameter. * * Accepts URL parameters and file uploads. For more details, see docs: * * https://server.sasjs.io/storedprograms * - * The response will be a JSON object with the following root attributes: - * log, webout, headers. - * - * The webout attribute will be nested JSON ONLY if the response-header - * contains a content-type of application/json AND it is valid JSON. - * Otherwise it will be a stringified version of the webout content. * * @summary Execute a Stored Program, return a JSON object - * @param _program Location of SAS or JS code + * @param _program Location of code in SASjs Drive * @example _program "/Projects/myApp/some/program" */ @Post('/execute') diff --git a/api/tsoa.json b/api/tsoa.json index a3a0c86..048211a 100644 --- a/api/tsoa.json +++ b/api/tsoa.json @@ -20,7 +20,7 @@ "description": "Operations about clients" }, { - "name": "CODE", + "name": "Code", "description": "Execution of code (various runtimes are supported)" }, {