@serenity-js/rest 3.25.0 → 3.25.1

package/src/screenplay/models/DeleteRequest.ts

@@ -46,11 +46,11 @@ export 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 {
         return new DeleteRequest(resourceUri);
@@ -58,11 +58,11 @@ export class DeleteRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/GetRequest.ts

@@ -53,11 +53,11 @@ export 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 {
         return new GetRequest(resourceUri);
@@ -65,11 +65,11 @@ export class GetRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/HTTPRequest.ts

@@ -4,8 +4,8 @@ import { d } from '@serenity-js/core/lib/io';
 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 abstract class HTTPRequest extends Question<Promise<AxiosRequestConfig>>
      *
      * @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(
         protected readonly resourceUri?: Answerable<string>,

package/src/screenplay/models/HeadRequest.ts

@@ -38,11 +38,11 @@ export class HeadRequest 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>): HeadRequest {
         return new HeadRequest(resourceUri);
@@ -50,11 +50,11 @@ export class HeadRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/OptionsRequest.ts

@@ -41,11 +41,11 @@ export class OptionsRequest 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>): OptionsRequest {
         return new OptionsRequest(resourceUri);
@@ -53,11 +53,11 @@ export class OptionsRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/PatchRequest.ts

@@ -38,11 +38,11 @@ export class PatchRequest 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>): PatchRequest {
         return new PatchRequest(resourceUri);
@@ -60,11 +60,11 @@ export class PatchRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/PostRequest.ts

@@ -78,11 +78,11 @@ export class PostRequest 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>): PostRequest {
         return new PostRequest(resourceUri);
@@ -100,11 +100,11 @@ export class PostRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/models/PutRequest.ts

@@ -48,11 +48,11 @@ export class PutRequest 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>): PutRequest {
         return new PutRequest(resourceUri);
@@ -70,11 +70,11 @@ export class PutRequest extends HTTPRequest {
 
     /**
      * 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/src/screenplay/questions/LastResponse.ts

@@ -5,8 +5,8 @@ import type { RawAxiosResponseHeaders } from 'axios';
 import { CallAnApi } from '../abilities';
 
 /**
- * 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/).
  *
  * ## Verify response to a GET request
  *
@@ -69,7 +69,7 @@ import { CallAnApi } from '../abilities';
 export class LastResponse {
 
     /**
-     * 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/)
      *
      * #### Learn more
      * - [HTTP response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
@@ -81,7 +81,7 @@ export class LastResponse {
     }
 
     /**
-     * Retrieves the body of the {@apilink LastResponse|last response}
+     * Retrieves the body of the [last response](https://serenity-js.org/api/rest/class/LastResponse/)
      *
      * #### A type-safe approach using generics
      *
@@ -161,7 +161,7 @@ export class LastResponse {
     }
 
     /**
-     * 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`
      *
      * ## Asserting on a header
      *
@@ -187,7 +187,7 @@ export class LastResponse {
     }
 
     /**
-     * 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/).
      *
      * ## Asserting on a header
      *