@serenity-js/rest 3.25.0 → 3.25.2

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.25.2](https://github.com/serenity-js/serenity-js/compare/v3.25.1...v3.25.2) (2024-07-17)
+
+
+### Bug Fixes
+
+* **deps:** update dependency lru-cache to v10.4.3 ([966a17c](https://github.com/serenity-js/serenity-js/commit/966a17c1df5d92508642aa5b34b6a4d1a1a4eafc))
+
+
+
+
+
+## [3.25.1](https://github.com/serenity-js/serenity-js/compare/v3.25.0...v3.25.1) (2024-07-10)
+
+
+### Bug Fixes
+
+* **core:** all the API docs now link to the online Serenity/JS API documentation ([f8f451d](https://github.com/serenity-js/serenity-js/commit/f8f451dffdb4caaa2e31a860f59d59470f4856ad))
+
+
+
+
+
 # [3.25.0](https://github.com/serenity-js/serenity-js/compare/v3.24.1...v3.25.0) (2024-07-03)
 
 

package/README.md

@@ -17,7 +17,7 @@ of complex software systems faster, more collaborative and easier to scale.
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
 - Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
-- Learn how to [contribute to Serenity/JS](https://serenity-js.org/contributing),
+- Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
 - Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
 
 ## Serenity/JS REST

package/lib/screenplay/abilities/CallAnApi.d.ts

@@ -3,8 +3,9 @@ import { Ability } from '@serenity-js/core';
 import { type AxiosDefaults, type AxiosInstance, type AxiosRequestConfig, type AxiosResponse } from 'axios';
 import type { AxiosRequestConfigDefaults } from '../../io';
 /**
- * An {@apilink Ability} that wraps [axios client](https://axios-http.com/docs/api_intro) and enables
- * the {@apilink Actor} to {@apilink Send} {@apilink HTTPRequest|HTTP requests} to HTTP APIs.
+ * An [ability](https://serenity-js.org/api/core/class/Ability/) that wraps [axios client](https://axios-http.com/docs/api_intro) and enables
+ * the [actor](https://serenity-js.org/api/core/class/Actor/) to [send](https://serenity-js.org/api/rest/class/Send/)
+ * [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/) to HTTP APIs.
  *
  * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
  * described in ["Node.js Axios behind corporate proxies"](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d)
@@ -183,7 +184,7 @@ import type { AxiosRequestConfigDefaults } from '../../io';
  *
  * ### Serenity/JS defaults
  *
- * When using {@apilink CallAnApi.at} or {@apilink CallAnApi.using} with a configuration object, Serenity/JS
+ * When using [`CallAnApi.at`](https://serenity-js.org/api/rest/class/CallAnApi/#at) or [`CallAnApi.using`](https://serenity-js.org/api/rest/class/CallAnApi/#using) with a configuration object, Serenity/JS
  * merges your [Axios request configuration](https://axios-http.com/docs/req_config) with the following defaults:
  * - `timeout`: 10 seconds
  *
@@ -220,7 +221,7 @@ import type { AxiosRequestConfigDefaults } from '../../io';
  *
  * ### Using API-specific actors
  *
- * To create API-specific actors, configure your [test runner](/handbook/test-runners/) with a {@apilink Cast}
+ * To create API-specific actors, configure your [test runner](https://serenity-js.org/handbook/test-runners/) with a [cast](https://serenity-js.org/api/core/class/Cast/)
  * that gives your actors appropriate abilities based, for example, on their name:
  *
  * ```ts
@@ -244,7 +245,7 @@ import type { AxiosRequestConfigDefaults } from '../../io';
  * beforeEach(() => engage(new MyActors()))
  * ```
  *
- * Next, retrieve the appropriate actor in your test scenario using {@apilink actorCalled}, for example:
+ * Next, retrieve the appropriate actor in your test scenario using [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/), for example:
  *
  * ```ts
  * import { describe, it, beforeEach } from 'mocha'
@@ -315,7 +316,7 @@ export declare class CallAnApi extends Ability {
     private readonly axiosInstance;
     private lastResponse;
     /**
-     * Produces an {@apilink Ability|ability} to call a REST API at a specified `baseURL`;
+     * Produces an [ability](https://serenity-js.org/api/core/class/Ability/) to call a REST API at a specified `baseURL`;
      *
      * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
      *
@@ -323,7 +324,7 @@ export declare class CallAnApi extends Ability {
      */
     static at(baseURL: URL | string): CallAnApi;
     /**
-     * Produces an {@apilink Ability|ability} to call an HTTP API using the given Axios instance,
+     * Produces an [ability](https://serenity-js.org/api/core/class/Ability/) to call an HTTP API using the given Axios instance,
      * or an Axios request configuration object.
      *
      * When you provide an [Axios configuration object](https://axios-http.com/docs/req_config),
@@ -335,7 +336,7 @@ export declare class CallAnApi extends Ability {
      * When you provide an Axios instance, it's enhanced with proxy support and no other modifications are made.
      *
      * If you don't want Serenity/JS to augment or modify your Axios instance in any way,
-     * please use the {@apilink CallAnApi.constructor} directly.
+     * please use the [`CallAnApi.constructor`](https://serenity-js.org/api/rest/class/CallAnApi/#constructor) directly.
      *
      * @param axiosInstanceOrConfig
      */
@@ -350,8 +351,8 @@ export declare class CallAnApi extends Ability {
     constructor(axiosInstance: AxiosInstance);
     /**
      * Allows for the original Axios config to be changed after
-     * the {@apilink Ability|ability} to {@apilink CallAnApi}
-     * has been instantiated and given to the {@apilink Actor}.
+     * the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * has been instantiated and given to the [`Actor`](https://serenity-js.org/api/core/class/Actor/).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
@@ -361,7 +362,7 @@ export declare class CallAnApi extends Ability {
     modifyConfig(fn: (original: AxiosDefaults<any>) => any): void;
     /**
      * Sends an HTTP request to a specified url.
-     * Response will be cached and available via {@apilink mapLastResponse}
+     * Response will be cached and available via [`CallAnApi.mapLastResponse`](https://serenity-js.org/api/rest/class/CallAnApi/#mapLastResponse).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
@@ -369,12 +370,13 @@ export declare class CallAnApi extends Ability {
      *
      * @param config
      *  Axios request configuration, which can be used to override the defaults
-     *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/)
+     *  to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      */
     request(config: AxiosRequestConfig): Promise<AxiosResponse>;
     /**
-     * Resolves the final URL, based on the {@apilink AxiosRequestConfig} provided
-     * and any defaults that the {@apilink AxiosInstance} has been configured with.
+     * Resolves the final URL, based on the [`AxiosRequestConfig`](https://axios-http.com/docs/req_config) provided
+     * and any defaults that the [`AxiosInstance`](https://axios-http.com/docs/instance) has been configured with.
      *
      * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
      * to ensure URLs are correctly resolved.
@@ -384,7 +386,7 @@ export declare class CallAnApi extends Ability {
     resolveUrl(config: AxiosRequestConfig): string;
     /**
      * Maps the last cached response to another type.
-     * Useful when you need to extract a portion of the {@apilink AxiosResponse} object.
+     * Useful when you need to extract a portion of the [`AxiosResponse`](https://axios-http.com/docs/res_schema) object.
      *
      * #### Learn more
      * - [AxiosResponse](https://axios-http.com/docs/res_schema)

package/lib/screenplay/abilities/CallAnApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CallAnApi.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAwD,MAAM,mBAAmB,CAAC;AAClG,OAAO,EACH,KAAK,aAAa,EAElB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EACrB,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,0BAA0B,EAAC,MAAM,UAAU,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoTG;AACH,qBAAa,SAAU,SAAQ,OAAO;IA+CtB,OAAO,CAAC,QAAQ,CAAC,aAAa;IA7C1C,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS;IAQ3C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,aAAa,GAAG,0BAA0B,GAAG,SAAS;IAI1F;;;;;;OAMG;gBAC0B,aAAa,EAAE,aAAa;IAIzD;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,IAAI;IAI7D;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCjE;;;;;;;;OAQG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAQ9C;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,CAAC,GAAG,CAAC;CAOzE"}
+{"version":3,"file":"CallAnApi.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAwD,MAAM,mBAAmB,CAAC;AAClG,OAAO,EACH,KAAK,aAAa,EAElB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EACrB,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,0BAA0B,EAAC,MAAM,UAAU,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqTG;AACH,qBAAa,SAAU,SAAQ,OAAO;IA+CtB,OAAO,CAAC,QAAQ,CAAC,aAAa;IA7C1C,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS;IAQ3C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,aAAa,GAAG,0BAA0B,GAAG,SAAS;IAI1F;;;;;;OAMG;gBAC0B,aAAa,EAAE,aAAa;IAIzD;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,IAAI;IAI7D;;;;;;;;;;;;OAYG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCjE;;;;;;;;OAQG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAQ9C;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,CAAC,GAAG,CAAC;CAOzE"}

package/lib/screenplay/abilities/CallAnApi.js

@@ -4,8 +4,9 @@ exports.CallAnApi = void 0;
 const core_1 = require("@serenity-js/core");
 const io_1 = require("../../io");
 /**
- * An {@apilink Ability} that wraps [axios client](https://axios-http.com/docs/api_intro) and enables
- * the {@apilink Actor} to {@apilink Send} {@apilink HTTPRequest|HTTP requests} to HTTP APIs.
+ * An [ability](https://serenity-js.org/api/core/class/Ability/) that wraps [axios client](https://axios-http.com/docs/api_intro) and enables
+ * the [actor](https://serenity-js.org/api/core/class/Actor/) to [send](https://serenity-js.org/api/rest/class/Send/)
+ * [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/) to HTTP APIs.
  *
  * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
  * described in ["Node.js Axios behind corporate proxies"](https://janmolak.com/node-js-axios-behind-corporate-proxies-8b17a6f31f9d)
@@ -184,7 +185,7 @@ const io_1 = require("../../io");
  *
  * ### Serenity/JS defaults
  *
- * When using {@apilink CallAnApi.at} or {@apilink CallAnApi.using} with a configuration object, Serenity/JS
+ * When using [`CallAnApi.at`](https://serenity-js.org/api/rest/class/CallAnApi/#at) or [`CallAnApi.using`](https://serenity-js.org/api/rest/class/CallAnApi/#using) with a configuration object, Serenity/JS
  * merges your [Axios request configuration](https://axios-http.com/docs/req_config) with the following defaults:
  * - `timeout`: 10 seconds
  *
@@ -221,7 +222,7 @@ const io_1 = require("../../io");
  *
  * ### Using API-specific actors
  *
- * To create API-specific actors, configure your [test runner](/handbook/test-runners/) with a {@apilink Cast}
+ * To create API-specific actors, configure your [test runner](https://serenity-js.org/handbook/test-runners/) with a [cast](https://serenity-js.org/api/core/class/Cast/)
  * that gives your actors appropriate abilities based, for example, on their name:
  *
  * ```ts
@@ -245,7 +246,7 @@ const io_1 = require("../../io");
  * beforeEach(() => engage(new MyActors()))
  * ```
  *
- * Next, retrieve the appropriate actor in your test scenario using {@apilink actorCalled}, for example:
+ * Next, retrieve the appropriate actor in your test scenario using [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/), for example:
  *
  * ```ts
  * import { describe, it, beforeEach } from 'mocha'
@@ -316,7 +317,7 @@ class CallAnApi extends core_1.Ability {
     axiosInstance;
     lastResponse;
     /**
-     * Produces an {@apilink Ability|ability} to call a REST API at a specified `baseURL`;
+     * Produces an [ability](https://serenity-js.org/api/core/class/Ability/) to call a REST API at a specified `baseURL`;
      *
      * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
      *
@@ -330,7 +331,7 @@ class CallAnApi extends core_1.Ability {
         });
     }
     /**
-     * Produces an {@apilink Ability|ability} to call an HTTP API using the given Axios instance,
+     * Produces an [ability](https://serenity-js.org/api/core/class/Ability/) to call an HTTP API using the given Axios instance,
      * or an Axios request configuration object.
      *
      * When you provide an [Axios configuration object](https://axios-http.com/docs/req_config),
@@ -342,7 +343,7 @@ class CallAnApi extends core_1.Ability {
      * When you provide an Axios instance, it's enhanced with proxy support and no other modifications are made.
      *
      * If you don't want Serenity/JS to augment or modify your Axios instance in any way,
-     * please use the {@apilink CallAnApi.constructor} directly.
+     * please use the [`CallAnApi.constructor`](https://serenity-js.org/api/rest/class/CallAnApi/#constructor) directly.
      *
      * @param axiosInstanceOrConfig
      */
@@ -362,8 +363,8 @@ class CallAnApi extends core_1.Ability {
     }
     /**
      * Allows for the original Axios config to be changed after
-     * the {@apilink Ability|ability} to {@apilink CallAnApi}
-     * has been instantiated and given to the {@apilink Actor}.
+     * the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * has been instantiated and given to the [`Actor`](https://serenity-js.org/api/core/class/Actor/).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
@@ -375,7 +376,7 @@ class CallAnApi extends core_1.Ability {
     }
     /**
      * Sends an HTTP request to a specified url.
-     * Response will be cached and available via {@apilink mapLastResponse}
+     * Response will be cached and available via [`CallAnApi.mapLastResponse`](https://serenity-js.org/api/rest/class/CallAnApi/#mapLastResponse).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
@@ -383,7 +384,8 @@ class CallAnApi extends core_1.Ability {
      *
      * @param config
      *  Axios request configuration, which can be used to override the defaults
-     *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/)
+     *  to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      */
     async request(config) {
         let url;
@@ -413,8 +415,8 @@ class CallAnApi extends core_1.Ability {
         }
     }
     /**
-     * Resolves the final URL, based on the {@apilink AxiosRequestConfig} provided
-     * and any defaults that the {@apilink AxiosInstance} has been configured with.
+     * Resolves the final URL, based on the [`AxiosRequestConfig`](https://axios-http.com/docs/req_config) provided
+     * and any defaults that the [`AxiosInstance`](https://axios-http.com/docs/instance) has been configured with.
      *
      * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
      * to ensure URLs are correctly resolved.
@@ -429,7 +431,7 @@ class CallAnApi extends core_1.Ability {
     }
     /**
      * Maps the last cached response to another type.
-     * Useful when you need to extract a portion of the {@apilink AxiosResponse} object.
+     * Useful when you need to extract a portion of the [`AxiosResponse`](https://axios-http.com/docs/res_schema) object.
      *
      * #### Learn more
      * - [AxiosResponse](https://axios-http.com/docs/res_schema)

package/lib/screenplay/abilities/CallAnApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"CallAnApi.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";;;AAAA,4CAAkG;AAUlG,iCAAuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoTG;AACH,MAAa,SAAU,SAAQ,cAAO;IA+CL;IA7CrB,YAAY,CAAgB;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,OAAqB;QAC3B,OAAO,SAAS,CAAC,KAAK,CAAC;YACnB,OAAO,EAAE,OAAO,YAAY,GAAG;gBAC3B,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACpB,CAAC,CAAC,OAAO;SAChB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAiE;QAC1E,OAAO,IAAI,SAAS,CAAC,IAAA,gBAAW,EAAC,qBAAqB,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,YAA6B,aAA4B;QACrD,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAe;IAEzD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAyC;QAClD,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,CAAC,MAA0B;QACpC,IAAI,GAAW,CAAC;QAEhB,IAAI;YACA,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;gBACjD,GAAG,MAAM;gBACT,GAAG;aACN,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,YAAY,CAAC;SAC5B;QACD,OAAO,KAAK,EAAE;YACV,MAAM,WAAW,GAAG,GAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAG,IAAK,GAAG,IAAI,MAAM,CAAC,GAAI,EAAE,CAAC;YAE9E,QAAQ,IAAI,EAAE;gBACV,KAAK,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACxC,MAAM,IAAI,2BAAoB,CAAC,8BAA+B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACzF,KAAK,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACpC,MAAM,IAAI,2BAAoB,CAAC,iCAAkC,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC5F,KAAK,KAAK,YAAY,SAAS;oBAC3B,MAAM,IAAI,yBAAkB,CAAC,wDAAwD,EAAE,KAAK,CAAC,CAAC;gBAClG,KAAK,CAAE,KAAoB,CAAC,QAAQ;oBAChC,MAAM,IAAI,2BAAoB,CAAC,4BAA6B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACvF;oBACI,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC;oBAEnC,OAAO,KAAK,CAAC,QAAQ,CAAC;aAC7B;SACJ;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,MAA0B;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC;QAEtE,OAAO,OAAO;YACV,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE;YACzC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAI,eAA+C;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,iBAAU,CAAC,sEAAsE,CAAC,CAAC;SAChG;QAED,OAAO,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACJ;AA9ID,8BA8IC"}
+{"version":3,"file":"CallAnApi.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";;;AAAA,4CAAkG;AAUlG,iCAAuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqTG;AACH,MAAa,SAAU,SAAQ,cAAO;IA+CL;IA7CrB,YAAY,CAAgB;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,OAAqB;QAC3B,OAAO,SAAS,CAAC,KAAK,CAAC;YACnB,OAAO,EAAE,OAAO,YAAY,GAAG;gBAC3B,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACpB,CAAC,CAAC,OAAO;SAChB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAiE;QAC1E,OAAO,IAAI,SAAS,CAAC,IAAA,gBAAW,EAAC,qBAAqB,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,YAA6B,aAA4B;QACrD,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAe;IAEzD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAyC;QAClD,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CAAC,MAA0B;QACpC,IAAI,GAAW,CAAC;QAEhB,IAAI;YACA,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;gBACjD,GAAG,MAAM;gBACT,GAAG;aACN,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,YAAY,CAAC;SAC5B;QACD,OAAO,KAAK,EAAE;YACV,MAAM,WAAW,GAAG,GAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAG,IAAK,GAAG,IAAI,MAAM,CAAC,GAAI,EAAE,CAAC;YAE9E,QAAQ,IAAI,EAAE;gBACV,KAAK,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACxC,MAAM,IAAI,2BAAoB,CAAC,8BAA+B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACzF,KAAK,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACpC,MAAM,IAAI,2BAAoB,CAAC,iCAAkC,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC5F,KAAK,KAAK,YAAY,SAAS;oBAC3B,MAAM,IAAI,yBAAkB,CAAC,wDAAwD,EAAE,KAAK,CAAC,CAAC;gBAClG,KAAK,CAAE,KAAoB,CAAC,QAAQ;oBAChC,MAAM,IAAI,2BAAoB,CAAC,4BAA6B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACvF;oBACI,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC;oBAEnC,OAAO,KAAK,CAAC,QAAQ,CAAC;aAC7B;SACJ;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,MAA0B;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC;QAEtE,OAAO,OAAO;YACV,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE;YACzC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAI,eAA+C;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,iBAAU,CAAC,sEAAsE,CAAC,CAAC;SAChG;QAED,OAAO,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACJ;AA/ID,8BA+IC"}

package/lib/screenplay/interactions/ChangeApiConfig.d.ts

@@ -1,8 +1,8 @@
 import type { Answerable } from '@serenity-js/core';
 import { Interaction } from '@serenity-js/core';
 /**
- * Changes configuration of the {@apilink Ability|ability} to {@apilink CallAnApi}
- * that the {@apilink Actor|actor} executing this {@apilink Interaction|interaction} has been configured with.
+ * Changes configuration of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+ * that the [actor](https://serenity-js.org/api/core/class/Actor/) executing this [interaction](https://serenity-js.org/api/core/class/Interaction/) has been configured with.
  *
  * ## Changing API URL for all subsequent requests
  *
@@ -86,7 +86,7 @@ import { Interaction } from '@serenity-js/core';
  * ## Handling sensitive information
  *
  * By design, any data handled by an actor appears in Serenity/JS reports.
- * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
  *
  * ```ts
  * import { actorCalled, Masked } from '@serenity-js/core'
@@ -108,24 +108,24 @@ import { Interaction } from '@serenity-js/core';
  */
 export declare class ChangeApiConfig {
     /**
-     * Instructs the {@apilink Actor|actor} to change the base URL
-     * of their {@apilink Ability|ability} to {@apilink CallAnApi}
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
      *
      * @param newApiUrl
      */
     static setUrlTo(newApiUrl: Answerable<string>): Interaction;
     /**
-     * Instructs the {@apilink Actor|actor} to change the port configured in the base URL
-     * of their {@apilink Ability|ability} to {@apilink CallAnApi}
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the port configured in the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
      *
      * @param newApiPort
      */
     static setPortTo(newApiPort: Answerable<number>): Interaction;
     /**
-     * Instructs the {@apilink Actor|actor} to change the configuration of the {@apilink AxiosInstance}
-     * used by their {@apilink Ability|ability} to {@apilink CallAnApi}
-     * and set an HTTP request header for any subsequent {@apilink HTTPRequest|HTTPRequests}
-     * issued via {@apilink Send}.
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the configuration of the [`AxiosInstance`](https://axios-http.com/docs/instance)
+     * used by their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * and set an HTTP request header for any subsequent [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     * issued via [`Send`](https://serenity-js.org/api/rest/class/Send/).
      *
      * @param name
      * @param value

package/lib/screenplay/interactions/ChangeApiConfig.js

@@ -5,8 +5,8 @@ const core_1 = require("@serenity-js/core");
 const url_1 = require("url");
 const abilities_1 = require("../abilities");
 /**
- * Changes configuration of the {@apilink Ability|ability} to {@apilink CallAnApi}
- * that the {@apilink Actor|actor} executing this {@apilink Interaction|interaction} has been configured with.
+ * Changes configuration of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+ * that the [actor](https://serenity-js.org/api/core/class/Actor/) executing this [interaction](https://serenity-js.org/api/core/class/Interaction/) has been configured with.
  *
  * ## Changing API URL for all subsequent requests
  *
@@ -90,7 +90,7 @@ const abilities_1 = require("../abilities");
  * ## Handling sensitive information
  *
  * By design, any data handled by an actor appears in Serenity/JS reports.
- * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
  *
  * ```ts
  * import { actorCalled, Masked } from '@serenity-js/core'
@@ -112,8 +112,8 @@ const abilities_1 = require("../abilities");
  */
 class ChangeApiConfig {
     /**
-     * Instructs the {@apilink Actor|actor} to change the base URL
-     * of their {@apilink Ability|ability} to {@apilink CallAnApi}
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
      *
      * @param newApiUrl
      */
@@ -121,8 +121,8 @@ class ChangeApiConfig {
         return new ChangeApiConfigSetUrl(newApiUrl);
     }
     /**
-     * Instructs the {@apilink Actor|actor} to change the port configured in the base URL
-     * of their {@apilink Ability|ability} to {@apilink CallAnApi}
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the port configured in the base URL
+     * of their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
      *
      * @param newApiPort
      */
@@ -130,10 +130,10 @@ class ChangeApiConfig {
         return new ChangeApiConfigSetPort(newApiPort);
     }
     /**
-     * Instructs the {@apilink Actor|actor} to change the configuration of the {@apilink AxiosInstance}
-     * used by their {@apilink Ability|ability} to {@apilink CallAnApi}
-     * and set an HTTP request header for any subsequent {@apilink HTTPRequest|HTTPRequests}
-     * issued via {@apilink Send}.
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to change the configuration of the [`AxiosInstance`](https://axios-http.com/docs/instance)
+     * used by their [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     * and set an HTTP request header for any subsequent [HTTP requests](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     * issued via [`Send`](https://serenity-js.org/api/rest/class/Send/).
      *
      * @param name
      * @param value

package/lib/screenplay/interactions/Send.d.ts

@@ -2,9 +2,9 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } f
 import { Interaction } from '@serenity-js/core';
 import type { AxiosRequestConfig } from 'axios';
 /**
- * Sends a {@apilink HTTPRequest} to a specified URL.
+ * Sends a [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/) to a specified URL.
  *
- * The response to the request is made available via {@apilink LastResponse}.
+ * The response to the request is made available via [`LastResponse`](https://serenity-js.org/api/rest/class/LastResponse/).
  *
  * ## Send a GET request
  *
@@ -26,7 +26,7 @@ import type { AxiosRequestConfig } from 'axios';
 export declare class Send extends Interaction {
     private readonly request;
     /**
-     * Instantiates a new {@apilink Interaction|interaction} to {@apilink Send}.
+     * Instantiates a new [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)

package/lib/screenplay/interactions/Send.js

@@ -6,9 +6,9 @@ const model_1 = require("@serenity-js/core/lib/model");
 const axios_1 = require("axios");
 const abilities_1 = require("../abilities");
 /**
- * Sends a {@apilink HTTPRequest} to a specified URL.
+ * Sends a [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/) to a specified URL.
  *
- * The response to the request is made available via {@apilink LastResponse}.
+ * The response to the request is made available via [`LastResponse`](https://serenity-js.org/api/rest/class/LastResponse/).
  *
  * ## Send a GET request
  *
@@ -30,7 +30,7 @@ const abilities_1 = require("../abilities");
 class Send extends core_1.Interaction {
     request;
     /**
-     * Instantiates a new {@apilink Interaction|interaction} to {@apilink Send}.
+     * Instantiates a new [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/).
      *
      * #### Learn more
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)

package/lib/screenplay/models/DeleteRequest.d.ts

@@ -42,20 +42,20 @@ export declare class DeleteRequest extends HTTPRequest {
      *
      * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
      * it gets concatenated with the URL provided to the Axios instance
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * @param resourceUri
-     *  The URI where the {@apilink Actor}
-     *  should send the {@apilink HTTPRequest}
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
      */
     static to(resourceUri: Answerable<string>): DeleteRequest;
     /**
      * Overrides the default Axios request configuration provided
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * #### Learn more
-     * - {@apilink Answerable}
-     * - {@apilink WithAnswerableProperties}
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config

package/lib/screenplay/models/DeleteRequest.js

@@ -44,22 +44,22 @@ class DeleteRequest extends HTTPRequest_1.HTTPRequest {
      *
      * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
      * it gets concatenated with the URL provided to the Axios instance
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * @param resourceUri
-     *  The URI where the {@apilink Actor}
-     *  should send the {@apilink HTTPRequest}
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
      */
     static to(resourceUri) {
         return new DeleteRequest(resourceUri);
     }
     /**
      * Overrides the default Axios request configuration provided
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * #### Learn more
-     * - {@apilink Answerable}
-     * - {@apilink WithAnswerableProperties}
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config

package/lib/screenplay/models/GetRequest.d.ts

@@ -49,20 +49,20 @@ export declare class GetRequest extends HTTPRequest {
      *
      * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
      * it gets concatenated with the URL provided to the Axios instance
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * @param resourceUri
-     *  The URI where the {@apilink Actor}
-     *  should send the {@apilink HTTPRequest}
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
      */
     static to(resourceUri: Answerable<string>): GetRequest;
     /**
      * Overrides the default Axios request configuration provided
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * #### Learn more
-     * - {@apilink Answerable}
-     * - {@apilink WithAnswerableProperties}
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config

package/lib/screenplay/models/GetRequest.js

@@ -51,22 +51,22 @@ class GetRequest extends HTTPRequest_1.HTTPRequest {
      *
      * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
      * it gets concatenated with the URL provided to the Axios instance
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * @param resourceUri
-     *  The URI where the {@apilink Actor}
-     *  should send the {@apilink HTTPRequest}
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
      */
     static to(resourceUri) {
         return new GetRequest(resourceUri);
     }
     /**
      * Overrides the default Axios request configuration provided
-     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
      *
      * #### Learn more
-     * - {@apilink Answerable}
-     * - {@apilink WithAnswerableProperties}
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
      * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config

package/lib/screenplay/models/HTTPRequest.d.ts

@@ -2,8 +2,8 @@ import type { Answerable, AnswersQuestions, UsesAbilities, WithAnswerablePropert
 import { Question } from '@serenity-js/core';
 import type { AxiosRequestConfig } from 'axios';
 /**
- * HTTP Request sent by the {@apilink Actor}
- * using the {@apilink Interaction|interaction} to {@apilink Send}
+ * HTTP Request sent by the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * using the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/)
  *
  * @group Models
  */
@@ -20,7 +20,7 @@ export declare abstract class HTTPRequest extends Question<Promise<AxiosRequestC
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} [config]
      *  Axios request configuration, which can be used to override the defaults
-     *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} is instantiated
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) is instantiated
      */
     protected constructor(resourceUri?: Answerable<string>, data?: Answerable<any>, config?: Answerable<WithAnswerableProperties<AxiosRequestConfig>>);
     /**

package/lib/screenplay/models/HTTPRequest.js

@@ -4,8 +4,8 @@ exports.HTTPRequest = void 0;
 const core_1 = require("@serenity-js/core");
 const io_1 = require("@serenity-js/core/lib/io");
 /**
- * HTTP Request sent by the {@apilink Actor}
- * using the {@apilink Interaction|interaction} to {@apilink Send}
+ * HTTP Request sent by the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * using the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Send`](https://serenity-js.org/api/rest/class/Send/)
  *
  * @group Models
  */
@@ -22,7 +22,7 @@ class HTTPRequest extends core_1.Question {
      *
      * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} [config]
      *  Axios request configuration, which can be used to override the defaults
-     *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} is instantiated
+     *  provided when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) is instantiated
      */
     constructor(resourceUri, data, config) {
         super(`${HTTPRequest.requestDescription(new.target.name)} to ${(0, io_1.d) `${resourceUri}`}`);