Merge pull request #81 from sasjs/doc-source-links

chore(doc): fix typo, add links to source code
2026-01-03 18:50:05 +00:00 · 2020-09-11 09:36:20 +01:00
parent 173e9746b1 60651f9570
commit 6f6e8b6b98
89 changed files with 15073 additions and 172 deletions
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
--- a/docs/assets/css/main.css.map
+++ b/docs/assets/css/main.css.map
--- a/docs/assets/js/main.js
+++ b/docs/assets/js/main.js
--- a/docs/assets/js/search.json
+++ b/docs/assets/js/search.json
--- a/docs/classes/_fileuploader_.fileuploader.html
+++ b/docs/classes/_fileuploader_.fileuploader.html
--- a/docs/classes/_sas9apiclient_.sas9apiclient.html
+++ b/docs/classes/_sas9apiclient_.sas9apiclient.html
--- a/docs/classes/_sasjs_.sasjs.html
+++ b/docs/classes/_sasjs_.sasjs.html
--- a/docs/classes/_sasviyaapiclient_.sasviyaapiclient.html
+++ b/docs/classes/_sasviyaapiclient_.sasviyaapiclient.html
--- a/docs/classes/_sessionmanager_.sessionmanager.html
+++ b/docs/classes/_sessionmanager_.sessionmanager.html
--- a/docs/classes/_types_sasjsconfig_.sasjsconfig.html
+++ b/docs/classes/_types_sasjsconfig_.sasjsconfig.html
--- a/docs/classes/reflection-708.reflection-180.fileuploader.html
+++ b/docs/classes/reflection-708.reflection-180.fileuploader.html
--- a/docs/classes/reflection-708.reflection-180.sas9apiclient.html
+++ b/docs/classes/reflection-708.reflection-180.sas9apiclient.html
--- a/docs/classes/reflection-708.reflection-180.sasjs.html
+++ b/docs/classes/reflection-708.reflection-180.sasjs.html
--- a/docs/classes/reflection-708.reflection-180.sasviyaapiclient.html
+++ b/docs/classes/reflection-708.reflection-180.sasviyaapiclient.html
--- a/docs/classes/reflection-708.reflection-180.sessionmanager.html
+++ b/docs/classes/reflection-708.reflection-180.sessionmanager.html
--- a/docs/classes/types.sasjsconfig.html
+++ b/docs/classes/types.sasjsconfig.html
--- a/docs/enums/_types_servertype_.servertype.html
+++ b/docs/enums/_types_servertype_.servertype.html
--- a/docs/enums/types.servertype.html
+++ b/docs/enums/types.servertype.html
--- a/docs/globals.html
+++ b/docs/globals.html
--- a/docs/index.html
+++ b/docs/index.html
--- a/docs/interfaces/_types_context_.context.html
+++ b/docs/interfaces/_types_context_.context.html
--- a/docs/interfaces/_types_context_.editcontextinput.html
+++ b/docs/interfaces/_types_context_.editcontextinput.html
--- a/docs/interfaces/_types_csrftoken_.csrftoken.html
+++ b/docs/interfaces/_types_csrftoken_.csrftoken.html
--- a/docs/interfaces/_types_folder_.folder.html
+++ b/docs/interfaces/_types_folder_.folder.html
--- a/docs/interfaces/_types_job_.job.html
+++ b/docs/interfaces/_types_job_.job.html
--- a/docs/interfaces/_types_jobdefinition_.jobdefinition.html
+++ b/docs/interfaces/_types_jobdefinition_.jobdefinition.html
--- a/docs/interfaces/_types_jobresult_.jobresult.html
+++ b/docs/interfaces/_types_jobresult_.jobresult.html
--- a/docs/interfaces/_types_link_.link.html
+++ b/docs/interfaces/_types_link_.link.html
--- a/docs/interfaces/_types_sasjsrequest_.sasjsrequest.html
+++ b/docs/interfaces/_types_sasjsrequest_.sasjsrequest.html
--- a/docs/interfaces/_types_sasjswaitingrequest_.sasjswaitingrequest.html
+++ b/docs/interfaces/_types_sasjswaitingrequest_.sasjswaitingrequest.html
--- a/docs/interfaces/_types_session_.session.html
+++ b/docs/interfaces/_types_session_.session.html
--- a/docs/interfaces/_types_uploadfile_.uploadfile.html
+++ b/docs/interfaces/_types_uploadfile_.uploadfile.html
--- a/docs/interfaces/types.context.html
+++ b/docs/interfaces/types.context.html
--- a/docs/interfaces/types.csrftoken.html
+++ b/docs/interfaces/types.csrftoken.html
--- a/docs/interfaces/types.editcontextinput.html
+++ b/docs/interfaces/types.editcontextinput.html
--- a/docs/interfaces/types.folder.html
+++ b/docs/interfaces/types.folder.html
--- a/docs/interfaces/types.job.html
+++ b/docs/interfaces/types.job.html
--- a/docs/interfaces/types.jobdefinition.html
+++ b/docs/interfaces/types.jobdefinition.html
--- a/docs/interfaces/types.jobresult.html
+++ b/docs/interfaces/types.jobresult.html
--- a/docs/interfaces/types.link.html
+++ b/docs/interfaces/types.link.html
--- a/docs/interfaces/types.sasjsrequest.html
+++ b/docs/interfaces/types.sasjsrequest.html
--- a/docs/interfaces/types.sasjswaitingrequest.html
+++ b/docs/interfaces/types.sasjswaitingrequest.html
--- a/docs/interfaces/types.session.html
+++ b/docs/interfaces/types.session.html
--- a/docs/interfaces/types.uploadfile.html
+++ b/docs/interfaces/types.uploadfile.html
--- a/docs/modules/_fileuploader_.html
+++ b/docs/modules/_fileuploader_.html
--- a/docs/modules/_sas9apiclient_.html
+++ b/docs/modules/_sas9apiclient_.html
--- a/docs/modules/_sasjs_.html
+++ b/docs/modules/_sasjs_.html
--- a/docs/modules/_sasviyaapiclient_.html
+++ b/docs/modules/_sasviyaapiclient_.html
--- a/docs/modules/_sessionmanager_.html
+++ b/docs/modules/_sessionmanager_.html
--- a/docs/modules/_types_context_.html
+++ b/docs/modules/_types_context_.html
--- a/docs/modules/_types_csrftoken_.html
+++ b/docs/modules/_types_csrftoken_.html
--- a/docs/modules/_types_folder_.html
+++ b/docs/modules/_types_folder_.html
--- a/docs/modules/_types_job_.html
+++ b/docs/modules/_types_job_.html
--- a/docs/modules/_types_jobdefinition_.html
+++ b/docs/modules/_types_jobdefinition_.html
--- a/docs/modules/_types_jobresult_.html
+++ b/docs/modules/_types_jobresult_.html
--- a/docs/modules/_types_link_.html
+++ b/docs/modules/_types_link_.html
--- a/docs/modules/_types_sasjsconfig_.html
+++ b/docs/modules/_types_sasjsconfig_.html
--- a/docs/modules/_types_sasjsrequest_.html
+++ b/docs/modules/_types_sasjsrequest_.html
--- a/docs/modules/_types_sasjswaitingrequest_.html
+++ b/docs/modules/_types_sasjswaitingrequest_.html
--- a/docs/modules/_types_servertype_.html
+++ b/docs/modules/_types_servertype_.html
--- a/docs/modules/_types_session_.html
+++ b/docs/modules/_types_session_.html
--- a/docs/modules/_types_uploadfile_.html
+++ b/docs/modules/_types_uploadfile_.html
--- a/docs/modules/_utils_asyncforeach_.html
+++ b/docs/modules/_utils_asyncforeach_.html
--- a/docs/modules/_utils_comparetimestamps_.html
+++ b/docs/modules/_utils_comparetimestamps_.html
--- a/docs/modules/_utils_converttocsv_.html
+++ b/docs/modules/_utils_converttocsv_.html
--- a/docs/modules/_utils_formatdataforrequest_.html
+++ b/docs/modules/_utils_formatdataforrequest_.html
--- a/docs/modules/_utils_isauthorizeformrequired_.html
+++ b/docs/modules/_utils_isauthorizeformrequired_.html
--- a/docs/modules/_utils_isieoredge_.html
+++ b/docs/modules/_utils_isieoredge_.html
--- a/docs/modules/_utils_isloginrequired_.html
+++ b/docs/modules/_utils_isloginrequired_.html
--- a/docs/modules/_utils_isloginsuccess_.html
+++ b/docs/modules/_utils_isloginsuccess_.html
--- a/docs/modules/_utils_isuri_.html
+++ b/docs/modules/_utils_isuri_.html
--- a/docs/modules/_utils_isurl_.html
+++ b/docs/modules/_utils_isurl_.html
--- a/docs/modules/_utils_makerequest_.html
+++ b/docs/modules/_utils_makerequest_.html
--- a/docs/modules/_utils_needsretry_.html
+++ b/docs/modules/_utils_needsretry_.html
--- a/docs/modules/_utils_parseandsubmitauthorizeform_.html
+++ b/docs/modules/_utils_parseandsubmitauthorizeform_.html
--- a/docs/modules/_utils_parsegeneratedcode_.html
+++ b/docs/modules/_utils_parsegeneratedcode_.html
--- a/docs/modules/_utils_parsesasviyalog_.html
+++ b/docs/modules/_utils_parsesasviyalog_.html
--- a/docs/modules/_utils_parsesourcecode_.html
+++ b/docs/modules/_utils_parsesourcecode_.html
--- a/docs/modules/_utils_parseweboutresponse_.html
+++ b/docs/modules/_utils_parseweboutresponse_.html
--- a/docs/modules/_utils_serialize_.html
+++ b/docs/modules/_utils_serialize_.html
--- a/docs/modules/_utils_splitchunks_.html
+++ b/docs/modules/_utils_splitchunks_.html
--- a/docs/modules/reflection-708.html
+++ b/docs/modules/reflection-708.html
--- a/docs/modules/reflection-708.reflection-180.html
+++ b/docs/modules/reflection-708.reflection-180.html
--- a/docs/modules/types.html
+++ b/docs/modules/types.html
--- a/docs/modules/utils.html
+++ b/docs/modules/utils.html
--- a/package-lock.json
+++ b/package-lock.json
@@ -14424,24 +14424,6 @@
        "typedoc": "~0.17.8"
      }
    },
-    "typedoc-plugin-external-module-name": {
-      "version": "4.0.3",
-      "resolved": "https://registry.npmjs.org/typedoc-plugin-external-module-name/-/typedoc-plugin-external-module-name-4.0.3.tgz",
-      "integrity": "sha512-2PjEN9kdmkB7NxN3DEax6yDIPjq7HV8qELQhkSRJGxJs/8G/ZwPPvXT0z6hUqtWVr6MeCjpAoYJFzHo04C14Aw==",
-      "dev": true,
-      "requires": {
-        "lodash": "^4.1.2",
-        "semver": "^7.1.1"
-      },
-      "dependencies": {
-        "semver": {
-          "version": "7.3.2",
-          "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.2.tgz",
-          "integrity": "sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==",
-          "dev": true
-        }
-      }
-    },
    "typescript": {
      "version": "3.9.7",
      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.7.tgz",
--- a/package.json
+++ b/package.json
@@ -49,7 +49,6 @@
    "tslint-config-prettier": "^1.18.0",
    "typedoc": "^0.17.8",
    "typedoc-neo-theme": "^1.0.10",
-    "typedoc-plugin-external-module-name": "^4.0.3",
    "typescript": "^3.9.7",
    "uglifyjs-webpack-plugin": "^2.2.0",
    "webpack": "^4.44.1",
--- a/src/SASViyaApiClient.ts
+++ b/src/SASViyaApiClient.ts
@@ -282,7 +282,7 @@ export class SASViyaApiClient {
   */
  public async editContext(
    contextId: string,
-    updatedContext: EditContextInput,
+    editedContext: EditContextInput,
    accessToken?: string
  ) {
    if (!contextId) {
@@ -325,8 +325,8 @@ export class SASViyaApiClient {
      headers,
      body: JSON.stringify({
        ...context,
-        ...updatedContext,
-        attributes: { ...context.attributes, ...updatedContext.attributes }
+        ...editedContext,
+        attributes: { ...context.attributes, ...editedContext.attributes }
      })
    }

--- a/typedoc.json
+++ b/typedoc.json
@@ -11,14 +11,14 @@
  "outline": [
    {
      "SAS Adapter": {
-        "SASjs": "modules/sasjs",
-        "SASjsConfig": "classes/sasjsconfig.sasjsconfig-1",
-        "ServerType": "enums/servertype.servertype-1",
-        "SASjsRequest": "interfaces/sasjsrequest.sasjsrequest-1",
-        "SASjsWaitingRequest": "interfaces/sasjswaitingrequest.sasjswaitingrequest-1"
+        "SASjs": "modules/_sasjs_",
+        "SASjsConfig": "classes/_index_sasjsconfig",
+        "ServerType": "enums/_types_servertype_.servertype",
+        "SASjsRequest": "interfaces/_types_sasjsrequest_.sasjsrequest",
+        "SASjsWaitingRequest": "interfaces/_types_sasjswaitingrequest_.sasjswaitingrequest"
      },
-      "SAS Viya API Client": "classes/sasviyaapiclient.sasviyaapiclient-1",
-      "SAS 9 API Client": "classes/sas9apiclient.sas9apiclient-1"
+      "SAS Viya API Client": "classes/_sasviyaapiclient_.sasviyaapiclient",
+      "SAS 9 API Client": "classes/_sas9apiclient_.sas9apiclient"
    }
  ],
  "links": [
@@ -38,5 +38,11 @@
      "label": "React Seed App",
      "url": "https://github.com/sasjs/react-seed-app"
    }
+  ],
+  "source": [
+    {
+      "path": "https://github.com/sasjs/adapter/blob/master/src/",
+      "line": "L"
+    }
  ]
 }