Add documentation links

Qytera-Gmbh · May 13, 2024 · 8c0bae5 · 8c0bae5
1 parent 7b48916
commit 8c0bae5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/cypress/tasks.ts b/src/cypress/tasks.ts
@@ -29,7 +29,7 @@ export enum PluginTask {
  * @param filename - the name of the evidence file to save the request data to
  * @param request - the request data
  *
- * @see https://qytera-gmbh.github.io/projects/cypress-xray-plugin/section/configuration/xray/#uploadRequests
+ * @see https://qytera-gmbh.github.io/projects/cypress-xray-plugin/section/guides/uploadRequestData/
  */
 export function enqueueTask(
     task: PluginTask.OUTGOING_REQUEST,
@@ -45,7 +45,7 @@ export function enqueueTask(
  * @param filename - the name of the evidence file to save the response data to
  * @param response - the response data
  *
- * @see https://qytera-gmbh.github.io/projects/cypress-xray-plugin/section/configuration/xray/#uploadRequests
+ * @see https://qytera-gmbh.github.io/projects/cypress-xray-plugin/section/guides/uploadRequestData/
  */
 export function enqueueTask(
     task: PluginTask.INCOMING_RESPONSE,

diff --git a/src/types/plugin.ts b/src/types/plugin.ts
@@ -276,11 +276,13 @@ export interface XrayOptions {
      */
     testEnvironments?: [string, ...string[]];
     /**
-     * Turns on or off the upload of manually performed requests using `cy.request`. If `true`,
-     * requests and responses will be attached as evidence to the corresponding test. If `false` or
-     * if left `undefined`, neither requests nor responses will be attached.
+     * Enables or disables the upload of manually executed requests using `cy.request`. If `true`,
+     * requests and responses will be attached to the corresponding test as evidence. If `false` or
+     * left `undefined`, neither requests nor responses are attached.
      *
      * *Note: For this option to work properly, you need to overwrite the `cy.request` command.*
+     *
+     * @see https://qytera-gmbh.github.io/projects/cypress-xray-plugin/section/guides/uploadRequestData/
      */
     uploadRequests?: boolean;
     /**