@serenity-js/rest - npm Package Compare versions

Comparing version 3.25.0 to 3.25.1

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+## [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)
@@ -8,0 +19,0 @@

lib/screenplay/abilities/CallAnApi.d.ts

@@ -6,4 +6,5 @@ /// <reference types="node" />
 /**
- * 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.
  *
@@ -187,3 +188,3 @@ * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
  *
- * 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:
@@ -225,3 +226,3 @@ * - `timeout`: 10 seconds
  *
- * 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:
@@ -250,3 +251,3 @@ *
  *
- * 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:
  *
@@ -322,3 +323,3 @@ * ```ts
     /**
-     * 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`;
      *
@@ -331,3 +332,3 @@ * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
     /**
-     * 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.
@@ -344,3 +345,3 @@ *
      * 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.
      *
@@ -360,4 +361,4 @@ * @param axiosInstanceOrConfig
      * 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/).
      *
@@ -372,3 +373,3 @@ * #### Learn more
      * 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).
      *
@@ -381,8 +382,9 @@ * #### Learn more
      *  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.
      *
@@ -397,3 +399,3 @@ * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
      * 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.
      *
@@ -400,0 +402,0 @@ * #### Learn more

lib/screenplay/abilities/CallAnApi.js

@@ -7,4 +7,5 @@ "use strict";
 /**
- * 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.
  *
@@ -188,3 +189,3 @@ * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
  *
- * 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:
@@ -226,3 +227,3 @@ * - `timeout`: 10 seconds
  *
- * 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:
@@ -251,3 +252,3 @@ *
  *
- * 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:
  *
@@ -323,3 +324,3 @@ * ```ts
     /**
-     * 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`;
      *
@@ -338,3 +339,3 @@ * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
     /**
-     * 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.
@@ -351,3 +352,3 @@ *
      * 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.
      *
@@ -372,4 +373,4 @@ * @param axiosInstanceOrConfig
      * 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/).
      *
@@ -386,3 +387,3 @@ * #### Learn more
      * 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).
      *
@@ -395,3 +396,4 @@ * #### Learn more
      *  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.
      */
@@ -426,4 +428,4 @@ async request(config) {
     /**
-     * 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.
      *
@@ -443,3 +445,3 @@ * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
      * 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.
      *
@@ -446,0 +448,0 @@ * #### Learn more

lib/screenplay/interactions/ChangeApiConfig.d.ts

 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.
  *
@@ -89,3 +89,3 @@ * ## Changing API URL for all subsequent requests
  * 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/).
  *
@@ -112,4 +112,4 @@ * ```ts
     /**
-     * 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/)
      *
@@ -120,4 +120,4 @@ * @param 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/)
      *
@@ -128,6 +128,6 @@ * @param 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/).
      *
@@ -134,0 +134,0 @@ * @param name

lib/screenplay/interactions/ChangeApiConfig.js

@@ -8,4 +8,4 @@ "use strict";
 /**
- * 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.
  *
@@ -94,3 +94,3 @@ * ## Changing API URL for all subsequent requests
  * 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/).
  *
@@ -117,4 +117,4 @@ * ```ts
     /**
-     * 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/)
      *
@@ -127,4 +127,4 @@ * @param 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/)
      *
@@ -137,6 +137,6 @@ * @param 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/).
      *
@@ -143,0 +143,0 @@ * @param name

lib/screenplay/interactions/Send.d.ts

@@ -5,5 +5,5 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } from '@serenity-js/core';
 /**
- * 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/).
  *
@@ -30,3 +30,3 @@ * ## Send a GET 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/).
      *
@@ -33,0 +33,0 @@ * #### Learn more

lib/screenplay/interactions/Send.js

@@ -9,5 +9,5 @@ "use strict";
 /**
- * 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/).
  *
@@ -34,3 +34,3 @@ * ## Send a GET 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/).
      *
@@ -37,0 +37,0 @@ * #### Learn more

lib/screenplay/models/DeleteRequest.d.ts

@@ -45,7 +45,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -55,7 +55,7 @@ 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)
@@ -62,0 +62,0 @@ *

lib/screenplay/models/DeleteRequest.js

@@ -47,7 +47,7 @@ "use strict";
      * 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/)
      */
@@ -59,7 +59,7 @@ static to(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)
@@ -66,0 +66,0 @@ *

lib/screenplay/models/GetRequest.d.ts

@@ -52,7 +52,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -62,7 +62,7 @@ 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)
@@ -69,0 +69,0 @@ *

lib/screenplay/models/GetRequest.js

@@ -54,7 +54,7 @@ "use strict";
      * 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/)
      */
@@ -66,7 +66,7 @@ static to(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)
@@ -73,0 +73,0 @@ *

lib/screenplay/models/HeadRequest.d.ts

@@ -37,7 +37,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -47,7 +47,7 @@ static to(resourceUri: Answerable<string>): HeadRequest;
      * 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)
@@ -54,0 +54,0 @@ *

lib/screenplay/models/HeadRequest.js

@@ -39,7 +39,7 @@ "use strict";
      * 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/)
      */
@@ -51,7 +51,7 @@ static to(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)
@@ -58,0 +58,0 @@ *

lib/screenplay/models/HTTPRequest.d.ts

@@ -5,4 +5,4 @@ import type { Answerable, AnswersQuestions, UsesAbilities, WithAnswerableProperties } from '@serenity-js/core';
 /**
- * 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/)
  *
@@ -24,3 +24,3 @@ * @group Models
      *  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
      */
@@ -27,0 +27,0 @@ protected constructor(resourceUri?: Answerable<string>, data?: Answerable<any>, config?: Answerable<WithAnswerableProperties<AxiosRequestConfig>>);

lib/screenplay/models/HTTPRequest.js

@@ -7,4 +7,4 @@ "use strict";
 /**
- * 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/)
  *
@@ -26,3 +26,3 @@ * @group Models
      *  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
      */
@@ -29,0 +29,0 @@ constructor(resourceUri, data, config) {

lib/screenplay/models/OptionsRequest.d.ts

@@ -40,7 +40,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -50,7 +50,7 @@ static to(resourceUri: Answerable<string>): OptionsRequest;
      * 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)
@@ -57,0 +57,0 @@ *

lib/screenplay/models/OptionsRequest.js

@@ -42,7 +42,7 @@ "use strict";
      * 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/)
      */
@@ -54,7 +54,7 @@ static to(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)
@@ -61,0 +61,0 @@ *

lib/screenplay/models/PatchRequest.d.ts

@@ -37,7 +37,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -54,7 +54,7 @@ static to(resourceUri: Answerable<string>): PatchRequest;
      * 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)
@@ -61,0 +61,0 @@ *

lib/screenplay/models/PatchRequest.js

@@ -39,7 +39,7 @@ "use strict";
      * 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/)
      */
@@ -60,7 +60,7 @@ static to(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)
@@ -67,0 +67,0 @@ *

lib/screenplay/models/PostRequest.d.ts

@@ -77,7 +77,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -94,7 +94,7 @@ static to(resourceUri: Answerable<string>): PostRequest;
      * 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)
@@ -101,0 +101,0 @@ *

lib/screenplay/models/PostRequest.js

@@ -79,7 +79,7 @@ "use strict";
      * 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/)
      */
@@ -100,7 +100,7 @@ static to(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)
@@ -107,0 +107,0 @@ *

lib/screenplay/models/PutRequest.d.ts

@@ -47,7 +47,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -64,7 +64,7 @@ static to(resourceUri: Answerable<string>): PutRequest;
      * 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)
@@ -71,0 +71,0 @@ *

lib/screenplay/models/PutRequest.js

@@ -49,7 +49,7 @@ "use strict";
      * 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/)
      */
@@ -70,7 +70,7 @@ static to(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)
@@ -77,0 +77,0 @@ *

lib/screenplay/questions/LastResponse.d.ts

 import type { QuestionAdapter } from '@serenity-js/core';
 import type { RawAxiosResponseHeaders } from 'axios';
 /**
- * Provides access to the properties of the last {@apilink AxiosResponse} object,
- * cached on the {@apilink Ability|ability} to {@apilink CallAnApi}.
+ * Provides access to the properties of the last [`AxiosResponse`](https://axios-http.com/docs/res_schema) object,
+ * cached on the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/).
  *
@@ -67,3 +67,3 @@ * ## Verify response to a GET request
     /**
-     * Retrieves the status code of the {@apilink LastResponse|last response}
+     * Retrieves the status code of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -75,3 +75,3 @@ * #### Learn more
     /**
-     * Retrieves the body of the {@apilink LastResponse|last response}
+     * Retrieves the body of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -151,3 +151,3 @@ * #### A type-safe approach using generics
     /**
-     * Retrieves a header of the {@apilink LastResponse|last response}, identified by `name`
+     * Retrieves a header of the [last response](https://serenity-js.org/api/rest/class/LastResponse/), identified by `name`
      *
@@ -173,3 +173,3 @@ * ## Asserting on a header
     /**
-     * Retrieves all the headers of the {@apilink LastResponse|last response}.
+     * Retrieves all the headers of the [last response](https://serenity-js.org/api/rest/class/LastResponse/).
      *
@@ -176,0 +176,0 @@ * ## Asserting on a header

lib/screenplay/questions/LastResponse.js

@@ -7,4 +7,4 @@ "use strict";
 /**
- * Provides access to the properties of the last {@apilink AxiosResponse} object,
- * cached on the {@apilink Ability|ability} to {@apilink CallAnApi}.
+ * Provides access to the properties of the last [`AxiosResponse`](https://axios-http.com/docs/res_schema) object,
+ * cached on the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/).
  *
@@ -71,3 +71,3 @@ * ## Verify response to a GET request
     /**
-     * Retrieves the status code of the {@apilink LastResponse|last response}
+     * Retrieves the status code of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -83,3 +83,3 @@ * #### Learn more
     /**
-     * Retrieves the body of the {@apilink LastResponse|last response}
+     * Retrieves the body of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -163,3 +163,3 @@ * #### A type-safe approach using generics
     /**
-     * Retrieves a header of the {@apilink LastResponse|last response}, identified by `name`
+     * Retrieves a header of the [last response](https://serenity-js.org/api/rest/class/LastResponse/), identified by `name`
      *
@@ -189,3 +189,3 @@ * ## Asserting on a header
     /**
-     * Retrieves all the headers of the {@apilink LastResponse|last response}.
+     * Retrieves all the headers of the [last response](https://serenity-js.org/api/rest/class/LastResponse/).
      *
@@ -192,0 +192,0 @@ * ## Asserting on a header

package.json

 {
   "name": "@serenity-js/rest",
-  "version": "3.25.0",
+  "version": "3.25.1",
   "description": "Test REST APIs with Serenity/JS",
@@ -49,3 +49,3 @@ "author": {
   "dependencies": {
-    "@serenity-js/core": "3.25.0",
+    "@serenity-js/core": "3.25.1",
     "agent-base": "7.1.1",
@@ -61,3 +61,3 @@ "axios": "1.7.2",
     "@integration/testing-tools": "3.0.0",
-    "@serenity-js/assertions": "3.25.0",
+    "@serenity-js/assertions": "3.25.1",
     "@types/chai": "4.3.16",
@@ -72,3 +72,3 @@ "@types/mocha": "10.0.7",
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

README.md

@@ -20,3 +20,3 @@ # Serenity/JS
 - 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)!
@@ -23,0 +23,0 @@

src/screenplay/abilities/CallAnApi.ts

@@ -14,4 +14,5 @@ import { Ability, ConfigurationError, LogicError, TestCompromisedError } from '@serenity-js/core';
 /**
- * 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.
  *
@@ -195,3 +196,3 @@ * `CallAnApi` uses [`proxy-from-env`](https://www.npmjs.com/package/proxy-from-env) and an approach
  *
- * 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:
@@ -233,3 +234,3 @@ * - `timeout`: 10 seconds
  *
- * 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:
@@ -258,3 +259,3 @@ *
  *
- * 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:
  *
@@ -331,3 +332,3 @@ * ```ts
     /**
-     * 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`;
      *
@@ -347,3 +348,3 @@ * This is the same as invoking `CallAnApi.using({ baseURL: 'https://example.org' })`
     /**
-     * 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.
@@ -360,3 +361,3 @@ *
      * 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.
      *
@@ -382,4 +383,4 @@ * @param axiosInstanceOrConfig
      * 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/).
      *
@@ -397,3 +398,3 @@ * #### Learn more
      * 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).
      *
@@ -406,3 +407,4 @@ * #### Learn more
      *  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.
      */
@@ -442,4 +444,4 @@ async 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.
      *
@@ -461,3 +463,3 @@ * Note that unlike Axios, this method uses the Node.js [WHATWG URL API](https://nodejs.org/api/url.html#new-urlinput-base)
      * 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.
      *
@@ -464,0 +466,0 @@ * #### Learn more

src/screenplay/interactions/ChangeApiConfig.ts

@@ -8,4 +8,4 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } 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.
  *
@@ -94,3 +94,3 @@ * ## Changing API URL for all subsequent requests
  * 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/).
  * 
@@ -118,4 +118,4 @@ * ```ts
     /**
-     * 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/)
      *
@@ -129,4 +129,4 @@ * @param 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/)
      *
@@ -140,6 +140,6 @@ * @param 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/).
      *
@@ -146,0 +146,0 @@ * @param name

src/screenplay/interactions/Send.ts

@@ -11,5 +11,5 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } from '@serenity-js/core';
 /**
- * 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/).
  *
@@ -36,3 +36,3 @@ * ## Send a GET 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/).
      *
@@ -39,0 +39,0 @@ * #### Learn more

src/screenplay/models/DeleteRequest.ts

@@ -49,7 +49,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -62,7 +62,7 @@ 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)
@@ -69,0 +69,0 @@ *

src/screenplay/models/GetRequest.ts

@@ -56,7 +56,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -69,7 +69,7 @@ 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)
@@ -76,0 +76,0 @@ *

src/screenplay/models/HeadRequest.ts

@@ -41,7 +41,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -54,7 +54,7 @@ static to(resourceUri: Answerable<string>): HeadRequest {
      * 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)
@@ -61,0 +61,0 @@ *

src/screenplay/models/HTTPRequest.ts

@@ -7,4 +7,4 @@ import type { Answerable, AnswersQuestions, UsesAbilities, WithAnswerableProperties } from '@serenity-js/core';
 /**
- * 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/)
  *
@@ -24,3 +24,3 @@ * @group Models
      *  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
      */
@@ -27,0 +27,0 @@ protected constructor(

src/screenplay/models/OptionsRequest.ts

@@ -44,7 +44,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -57,7 +57,7 @@ static to(resourceUri: Answerable<string>): OptionsRequest {
      * 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)
@@ -64,0 +64,0 @@ *

src/screenplay/models/PatchRequest.ts

@@ -41,7 +41,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -64,7 +64,7 @@ static to(resourceUri: Answerable<string>): PatchRequest {
      * 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)
@@ -71,0 +71,0 @@ *

src/screenplay/models/PostRequest.ts

@@ -81,7 +81,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -104,7 +104,7 @@ static to(resourceUri: Answerable<string>): PostRequest {
      * 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)
@@ -111,0 +111,0 @@ *

src/screenplay/models/PutRequest.ts

@@ -51,7 +51,7 @@ import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
      * 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/)
      */
@@ -74,7 +74,7 @@ static to(resourceUri: Answerable<string>): PutRequest {
      * 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)
@@ -81,0 +81,0 @@ *

src/screenplay/questions/LastResponse.ts

@@ -8,4 +8,4 @@ import type { QuestionAdapter } from '@serenity-js/core';
 /**
- * Provides access to the properties of the last {@apilink AxiosResponse} object,
- * cached on the {@apilink Ability|ability} to {@apilink CallAnApi}.
+ * Provides access to the properties of the last [`AxiosResponse`](https://axios-http.com/docs/res_schema) object,
+ * cached on the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/).
  *
@@ -73,3 +73,3 @@ * ## Verify response to a GET request
     /**
-     * Retrieves the status code of the {@apilink LastResponse|last response}
+     * Retrieves the status code of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -86,3 +86,3 @@ * #### Learn more
     /**
-     * Retrieves the body of the {@apilink LastResponse|last response}
+     * Retrieves the body of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
@@ -167,3 +167,3 @@ * #### A type-safe approach using generics
     /**
-     * Retrieves a header of the {@apilink LastResponse|last response}, identified by `name`
+     * Retrieves a header of the [last response](https://serenity-js.org/api/rest/class/LastResponse/), identified by `name`
      *
@@ -194,3 +194,3 @@ * ## Asserting on a header
     /**
-     * Retrieves all the headers of the {@apilink LastResponse|last response}.
+     * Retrieves all the headers of the [last response](https://serenity-js.org/api/rest/class/LastResponse/).
      *
@@ -197,0 +197,0 @@ * ## Asserting on a header

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

317319

increased by4.4%

Lines of code

5648

increased by0.11%

Dependency changes

• + Added@serenity-js/core@3.25.1(transitive)

• - Removed@serenity-js/core@3.25.0(transitive)

• Updated@serenity-js/core@3.25.1