Skip to content

Commit e73ba90

Browse files
himeshsiriwardanahimeshsiriwardana
authored
Merge pull request #5741 from wso2/fixing-product-is-issue-20909-1764223462
Fix: Correct typos in authentication REST API documentation for versions 6.0.0 and 6.1.0 (Product IS issue #20909)
2 parents 3963e53 + d1477f7 commit e73ba90

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

‎en/identity-server/6.0.0/docs/apis/use-the-authentication-rest-apis.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,29 @@ template: templates/swagger.html
3232
<tbody>
3333
<tr>
3434
<td>filter_policy</td>
35-
<td>The value is either <b>include</b> or <b>exclude</b>. An include indicates an allowlisvalue, whereas an <b>exclude</b> indicates a denylist value.</td>
35+
<td>The value is either <b>include</b> or <b>exclude</b>. An include indicates an allowlist value, whereas an <b>exclude</b> indicates a denylist value.</td>
3636
</tr>
3737
<tr>
3838
<td>remove_on_consume_from_api</td>
39-
<td>This decides whether to remove the parameters on a read. If set to true, parameters ardeleted upon read and won’t be available for subsequent API requests, unless they arrepopulated in the backend.</td>
39+
<td>This decides whether to remove the parameters on a read. If set to true, parameters are deleted upon read and won't be available for subsequent API requests, unless they are repopulated in the backend.</td>
4040
</tr>
4141
<tr>
4242
<td>parameters</td>
43-
<td>The list of parameters to be allowed/denied. The name attribute is used to specify thparameter name.</td>
43+
<td>The list of parameters to be allowed/denied. The name attribute is used to specify the parameter name.</td>
4444
</tr>
4545
<tr>
4646
<td>sessionDataKey</td>
4747
<td>
48-
<p>This is an identifier used by the Identity Server to maintain state information abouthis particular request from the service provider.</p>
48+
<p>This is an identifier used by the Identity Server to maintain state information about this particular request from the service provider.</p>
4949
<p>
5050
<div class="admonition note">
5151
<p class="admonition-title">Note</p>
52-
<p>The <b>sessionDataKey</b> query parameter is used to coordinate the request statacross components participating in the request flow. <br />
52+
<p>The <b>sessionDataKey</b> query parameter is used to coordinate the request state across components participating in the request flow. <br />
5353
<br/>
54-
The <b>sessionDataKey</b> does not correlate with the user session and at the end othe request flow, the request state maintained against it is cleared by eacparticipating component.
54+
The <b>sessionDataKey</b> does not correlate with the user session and at the end of the request flow, the request state maintained against it is cleared by each participating component.
5555
<br/>
5656
<br/>
57-
This means that even if an external party grabs the <b>sessionDataKey</b> they will nobe able to get into the authentication sequence.
57+
This means that even if an external party grabs the <b>sessionDataKey</b> they will not be able to get into the authentication sequence.
5858
</div>
5959
</p>
6060
</td>

‎en/identity-server/6.1.0/docs/apis/use-the-authentication-rest-apis.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,29 @@ template: templates/swagger.html
3232
<tbody>
3333
<tr>
3434
<td>filter_policy</td>
35-
<td>The value is either <b>include</b> or <b>exclude</b>. An include indicates an allowlisvalue, whereas an <b>exclude</b> indicates a denylist value.</td>
35+
<td>The value is either <b>include</b> or <b>exclude</b>. An include indicates an allowlist value, whereas an <b>exclude</b> indicates a denylist value.</td>
3636
</tr>
3737
<tr>
3838
<td>remove_on_consume_from_api</td>
39-
<td>This decides whether to remove the parameters on a read. If set to true, parameters ardeleted upon read and won’t be available for subsequent API requests, unless they arrepopulated in the backend.</td>
39+
<td>This decides whether to remove the parameters on a read. If set to true, parameters are deleted upon read and won't be available for subsequent API requests, unless they are repopulated in the backend.</td>
4040
</tr>
4141
<tr>
4242
<td>parameters</td>
43-
<td>The list of parameters to be allowed/denied. The name attribute is used to specify thparameter name.</td>
43+
<td>The list of parameters to be allowed/denied. The name attribute is used to specify the parameter name.</td>
4444
</tr>
4545
<tr>
4646
<td>sessionDataKey</td>
4747
<td>
48-
<p>This is an identifier used by the Identity Server to maintain state information abouthis particular request from the service provider.</p>
48+
<p>This is an identifier used by the Identity Server to maintain state information about this particular request from the service provider.</p>
4949
<p>
5050
<div class="admonition note">
5151
<p class="admonition-title">Note</p>
52-
<p>The <b>sessionDataKey</b> query parameter is used to coordinate the request statacross components participating in the request flow. <br />
52+
<p>The <b>sessionDataKey</b> query parameter is used to coordinate the request state across components participating in the request flow. <br />
5353
<br/>
54-
The <b>sessionDataKey</b> does not correlate with the user session and at the end othe request flow, the request state maintained against it is cleared by eacparticipating component.
54+
The <b>sessionDataKey</b> does not correlate with the user session and at the end of the request flow, the request state maintained against it is cleared by each participating component.
5555
<br/>
5656
<br/>
57-
This means that even if an external party grabs the <b>sessionDataKey</b> they will nobe able to get into the authentication sequence.
57+
This means that even if an external party grabs the <b>sessionDataKey</b> they will not be able to get into the authentication sequence.
5858
</div>
5959
</p>
6060
</td>

0 commit comments

Comments
 (0)