Skip to content

Commit 6e42207

Browse files
craigfowlerGithub Actions Workflow (bot)
authored andcommitted
Publish updated documentation website
1 parent 892beeb commit 6e42207

29 files changed

Lines changed: 987 additions & 328 deletions

docs/api/CSF.Screenplay.WebApis.Endpoint-1.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ <h2 id="CSF_Screenplay_WebApis_Endpoint_1_remarks">Remarks</h2>
191191
name for this endpoint. This will improve the readability of reports.
192192
</p>
193193
<p>
194-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
194+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
195195
</p>
196196
</div>
197197

@@ -329,7 +329,7 @@ <h2 id="seealso">See Also</h2>
329329
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
330330
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
331331
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
332-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
332+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
333333
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint</a>&lt;TParameters&gt;</div>
334334
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint</a>&lt;TParameters, TResult&gt;</div>
335335
</div>

docs/api/CSF.Screenplay.WebApis.Endpoint.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ <h2 id="CSF_Screenplay_WebApis_Endpoint_remarks">Remarks</h2>
181181
name for this endpoint. This will improve the readability of reports.
182182
</p>
183183
<p>
184-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
184+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
185185
</p>
186186
</div>
187187

@@ -319,7 +319,7 @@ <h2 id="seealso">See Also</h2>
319319
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
320320
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
321321
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
322-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
322+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
323323
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint</a>&lt;TParameters&gt;</div>
324324
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint</a>&lt;TParameters, TResult&gt;</div>
325325
</div>

docs/api/CSF.Screenplay.WebApis.EndpointBase.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h1 id="CSF_Screenplay_WebApis_EndpointBase" data-uid="CSF.Screenplay.WebApis.En
129129
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
130130
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
131131
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
132-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
132+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
133133
</dd>
134134
</dl>
135135

@@ -181,9 +181,9 @@ <h2 id="CSF_Screenplay_WebApis_EndpointBase_remarks">Remarks</h2>
181181
Usually one of the following pre-written endpoint types will be suitable for your use case.
182182
If not, pick the one which most closely matches your use-case and derive from that.
183183
</p>
184-
<ul><li><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint&lt;TResult&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint&lt;TParameters&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint&lt;TParameters&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint&lt;TParameters, TResult&gt;</a></li></ul>
184+
<ul><li><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint&lt;TResult&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint&lt;TParameters&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResult&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint&lt;TParameters&gt;</a></li><li><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint&lt;TParameters, TResult&gt;</a></li></ul>
185185
<p>
186-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
186+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
187187
</p>
188188
</div>
189189

@@ -478,7 +478,7 @@ <h2 id="seealso">See Also</h2>
478478
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
479479
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
480480
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
481-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
481+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
482482
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint</a>&lt;TParameters&gt;</div>
483483
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint</a>&lt;TParameters, TResult&gt;</div>
484484
</div>

docs/api/CSF.Screenplay.WebApis.JsonEndpoint-1.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h2 id="CSF_Screenplay_WebApis_JsonEndpoint_1_remarks">Remarks</h2>
189189
name for this endpoint. This will improve the readability of reports.
190190
</p>
191191
<p>
192-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
192+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
193193
</p>
194194
</div>
195195

@@ -340,7 +340,7 @@ <h2 id="seealso">See Also</h2>
340340
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
341341
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
342342
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
343-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
343+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
344344
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
345345
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint</a>&lt;TParameters, TResult&gt;</div>
346346
</div>

docs/api/CSF.Screenplay.WebApis.JsonEndpoint-2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h2 id="CSF_Screenplay_WebApis_JsonEndpoint_2_remarks">Remarks</h2>
199199
name for this endpoint. This will improve the readability of reports.
200200
</p>
201201
<p>
202-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
202+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
203203
</p>
204204
</div>
205205

@@ -350,7 +350,7 @@ <h2 id="seealso">See Also</h2>
350350
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
351351
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
352352
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
353-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
353+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
354354
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html">ParameterizedEndpoint</a>&lt;TParameters&gt;</div>
355355
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint</a>&lt;TParameters&gt;</div>
356356
</div>

docs/api/CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ <h2 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_1_remarks">Remarks</h2>
197197
name for this endpoint. This will improve the readability of reports.
198198
</p>
199199
<p>
200-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
200+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
201201
</p>
202202
</div>
203203

@@ -349,7 +349,7 @@ <h2 id="seealso">See Also</h2>
349349
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
350350
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint.html">Endpoint</a></div>
351351
<div><a class="xref" href="CSF.Screenplay.WebApis.Endpoint-1.html">Endpoint</a>&lt;TResult&gt;</div>
352-
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResponse&gt;</div>
352+
<div><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint</a>&lt;TParameters, TResult&gt;</div>
353353
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-1.html">JsonEndpoint</a>&lt;TParameters&gt;</div>
354354
<div><a class="xref" href="CSF.Screenplay.WebApis.JsonEndpoint-2.html">JsonEndpoint</a>&lt;TParameters, TResult&gt;</div>
355355
</div>

docs/api/CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<html>
33
<head>
44
<meta charset="utf-8">
5-
<title>Class ParameterizedEndpoint&lt;TParameters, TResponse&gt; | Screenplay </title>
5+
<title>Class ParameterizedEndpoint&lt;TParameters, TResult&gt; | Screenplay </title>
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="title" content="Class ParameterizedEndpoint&lt;TParameters, TResponse&gt; | Screenplay ">
7+
<meta name="title" content="Class ParameterizedEndpoint&lt;TParameters, TResult&gt; | Screenplay ">
88

99
<meta name="description" content="Base type for a Web API endpoint which has a strongly-typed request payload and which is expected to return a response body that exposes a strongly-typed object.">
1010
<link rel="icon" href="../favicon.ico">
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8989

9090

9191
<h1 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2" data-uid="CSF.Screenplay.WebApis.ParameterizedEndpoint`2" class="text-break">
92-
Class ParameterizedEndpoint&lt;TParameters, TResponse&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.WebApis/ParameterizedEndpoint.withResult.cs/#L43"><i class="bi bi-code-slash"></i></a>
92+
Class ParameterizedEndpoint&lt;TParameters, TResult&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.WebApis/ParameterizedEndpoint.withResult.cs/#L43"><i class="bi bi-code-slash"></i></a>
9393
</h1>
9494

9595
<div class="facts text-secondary">
@@ -102,7 +102,7 @@ <h1 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2" data-uid="CSF.Screenplay
102102
<div class="markdown conceptual"></div>
103103

104104
<div class="codewrapper">
105-
<pre><code class="lang-csharp hljs">public abstract class ParameterizedEndpoint&lt;TParameters, TResponse&gt; : EndpointBase, IHasName</code></pre>
105+
<pre><code class="lang-csharp hljs">public abstract class ParameterizedEndpoint&lt;TParameters, TResult&gt; : EndpointBase, IHasName</code></pre>
106106
</div>
107107

108108

@@ -112,7 +112,7 @@ <h4 class="section">Type Parameters</h4>
112112
<dt><code>TParameters</code></dt>
113113
<dd><p>The type of the parameters object which is required to create an HTTP request message</p>
114114
</dd>
115-
<dt><code>TResponse</code></dt>
115+
<dt><code>TResult</code></dt>
116116
<dd><p>The type of response that the endpoint is expected to return.</p>
117117
</dd>
118118
</dl>
@@ -122,7 +122,7 @@ <h4 class="section">Type Parameters</h4>
122122
<dd>
123123
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
124124
<div><a class="xref" href="CSF.Screenplay.WebApis.EndpointBase.html">EndpointBase</a></div>
125-
<div><span class="xref">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</span></div>
125+
<div><span class="xref">ParameterizedEndpoint&lt;TParameters, TResult&gt;</span></div>
126126
</dd>
127127
</dl>
128128

@@ -204,7 +204,7 @@ <h2 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2_remarks">Remarks</h2>
204204
name for this endpoint. This will improve the readability of reports.
205205
</p>
206206
<p>
207-
For more information, see the documentation article for <a class="xref" href="../docs/performables/WebApis.html">using web APIs</a>.
207+
For more information, see the documentation article for <a class="xref" href="../docs/extensions/webApis/index.html">using web APIs</a>.
208208
</p>
209209
</div>
210210

@@ -220,7 +220,7 @@ <h3 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2__ctor_System_String_Syste
220220
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.WebApis/ParameterizedEndpoint.withResult.cs/#L74"><i class="bi bi-code-slash"></i></a>
221221
</h3>
222222

223-
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</a> with a relative URI and an optional HTTP method.</p>
223+
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResult&gt;</a> with a relative URI and an optional HTTP method.</p>
224224
</div>
225225
<div class="markdown level1 conceptual"></div>
226226

@@ -265,7 +265,7 @@ <h3 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2__ctor_System_Uri_System_N
265265
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.WebApis/ParameterizedEndpoint.withResult.cs/#L87"><i class="bi bi-code-slash"></i></a>
266266
</h3>
267267

268-
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</a> with a URI and an optional HTTP method.</p>
268+
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResult&gt;</a> with a URI and an optional HTTP method.</p>
269269
</div>
270270
<div class="markdown level1 conceptual"></div>
271271

@@ -317,7 +317,7 @@ <h3 id="CSF_Screenplay_WebApis_ParameterizedEndpoint_2_GetHttpRequestMessageBuil
317317
<div class="markdown level1 conceptual"></div>
318318

319319
<div class="codewrapper">
320-
<pre><code class="lang-csharp hljs">public abstract HttpRequestMessageBuilder&lt;TResponse&gt; GetHttpRequestMessageBuilder(TParameters parameters)</code></pre>
320+
<pre><code class="lang-csharp hljs">public abstract HttpRequestMessageBuilder&lt;TResult&gt; GetHttpRequestMessageBuilder(TParameters parameters)</code></pre>
321321
</div>
322322

323323
<h4 class="section">Parameters</h4>
@@ -329,7 +329,7 @@ <h4 class="section">Parameters</h4>
329329

330330
<h4 class="section">Returns</h4>
331331
<dl class="parameters">
332-
<dt><a class="xref" href="CSF.Screenplay.WebApis.HttpRequestMessageBuilder-1.html">HttpRequestMessageBuilder</a>&lt;TResponse&gt;</dt>
332+
<dt><a class="xref" href="CSF.Screenplay.WebApis.HttpRequestMessageBuilder-1.html">HttpRequestMessageBuilder</a>&lt;TResult&gt;</dt>
333333
<dd><p>An HTTP request message builder</p>
334334
</dd>
335335
</dl>

docs/api/CSF.Screenplay.WebApis.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ <h3 id="classes">
154154
</dd>
155155
</dl>
156156
<dl class="jumplist">
157-
<dt><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</a></dt>
157+
<dt><a class="xref" href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html">ParameterizedEndpoint&lt;TParameters, TResult&gt;</a></dt>
158158
<dd><p>Base type for a Web API endpoint which has a strongly-typed request payload and which is expected to return a response body that exposes a strongly-typed object.</p>
159159
</dd>
160160
</dl>

docs/api/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@
916916
<a href="CSF.Screenplay.WebApis.ParameterizedEndpoint-1.html" name="" title="ParameterizedEndpoint&lt;TParameters&gt;">ParameterizedEndpoint&lt;TParameters&gt;</a>
917917
</li>
918918
<li>
919-
<a href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html" name="" title="ParameterizedEndpoint&lt;TParameters, TResponse&gt;">ParameterizedEndpoint&lt;TParameters, TResponse&gt;</a>
919+
<a href="CSF.Screenplay.WebApis.ParameterizedEndpoint-2.html" name="" title="ParameterizedEndpoint&lt;TParameters, TResult&gt;">ParameterizedEndpoint&lt;TParameters, TResult&gt;</a>
920920
</li>
921921
<li>
922922
<a href="CSF.Screenplay.WebApis.SendTheHttpRequest.html" name="" title="SendTheHttpRequest">SendTheHttpRequest</a>

docs/api/toc.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)