1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-05 03:30: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

@@ -313,7 +313,7 @@ export class SASViyaApiClient {
headers.Authorization = `Bearer ${accessToken}`
}
const originalContext = await this.getContextByName(
const originalContext = await this.getComputeContextByName(
contextName,
accessToken
)
@@ -372,7 +372,7 @@ export class SASViyaApiClient {
headers.Authorization = `Bearer ${accessToken}`
}
const context = await this.getContextByName(contextName, accessToken)
const context = await this.getComputeContextByName(contextName, accessToken)
const deleteContextRequest: RequestInit = {
method: 'DELETE',
@@ -1388,11 +1388,12 @@ export class SASViyaApiClient {
}
/**
* 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(
public async getComputeContextByName(
contextName: string,
accessToken?: string
): Promise<Context> {