1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-07 04:20:05 +00:00

docs(context): update docs related to getComputeContextByName function

This commit is contained in:
Yury Shkoda
2020-09-23 17:21:27 +03:00
parent 491bc3371c
commit d60c0850c2
5 changed files with 126 additions and 113 deletions

View File

@@ -168,14 +168,18 @@ export default class SASjs {
}
/**
* Returns a compute context.
* Returns a JSON representation of a compute context.
* @example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }
* @param contextName - the name of the context to return.
* @param accessToken - an access token for an authorized user.
*/
public async getContextByName(contextName: string, accessToken?: string) {
this.isMethodSupported('getContextByName', ServerType.SASViya)
public async getComputeContextByName(
contextName: string,
accessToken?: string
) {
this.isMethodSupported('getComputeContextByName', ServerType.SASViya)
return await this.sasViyaApiClient!.getContextByName(
return await this.sasViyaApiClient!.getComputeContextByName(
contextName,
accessToken
)