Skip to content

Fix: Remove unnecessary $ sign from filter parameter in API URLs for all affected versions (Product IS issue #27138) #5986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wso2-engineering-bot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Remove unnecessary $ sign from filter parameter in API URLs for all affected versions (Product IS issue #27138) #5986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Retrieve Tenant Resources Based on Search Parameters

This section guides you through using the ` /search `

Check failure on line 3 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:3:60 MD038/no-space-in-code Spaces inside code span elements [Context: "`         /search        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 3 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:3:44 MD038/no-space-in-code Spaces inside code span elements [Context: "`         /search        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
endpoint of the [Configuration Management REST
API]({{base_path}}/apis/use-the-configuration-management-rest-apis) to search for
tenant resources.
Expand All @@ -9,14 +9,14 @@

## /search endpoint

The ` /search ` endpoint of the Configuration Management

Check failure on line 12 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:12:22 MD038/no-space-in-code Spaces inside code span elements [Context: "`         /search        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 12 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:12:6 MD038/no-space-in-code Spaces inside code span elements [Context: "`         /search        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
REST API allows you to perform cross-tenant search for resources.

The search context URL should be as follows:

` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query} `
` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query} `

Check failure on line 17 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:17:108 MD038/no-space-in-code Spaces inside code span elements [Context: "...filter={search-query}        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 17 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:17:2 MD038/no-space-in-code Spaces inside code span elements [Context: "`         https://{host}:{port..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Here, the value of ` {search-query} ` should be in the

Check failure on line 19 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:19:44 MD038/no-space-in-code Spaces inside code span elements [Context: "...       {search-query}        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 19 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:19:21 MD038/no-space-in-code Spaces inside code span elements [Context: "`         {search-query}      ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
form of a configuration management search query. For information on how
to write a search condition that is in the form of a configuration
management search query, see [Write a configuration management search
Expand All @@ -39,7 +39,7 @@
### Configuration management primitive search condition

A primitive search condition is a string in the following form:
` {RESOURCE_SEARCH_PARAMETER} {PRIMITIVE_CONDITION_OPERATOR} '{VALUE}' `

Check failure on line 42 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:42:79 MD038/no-space-in-code Spaces inside code span elements [Context: "...N_OPERATOR} '{VALUE}'        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 42 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md:42:2 MD038/no-space-in-code Spaces inside code span elements [Context: "`         {RESOURCE_SEARCH_PAR..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Following are the parameters of a resource supported in a primitive
search condition and the corresponding values to replace the
Expand Down Expand Up @@ -202,13 +202,13 @@
<p>Super tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check failure on line 205 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 205, "column": 344}}}, "severity": "ERROR"}

Check warning on line 205 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 205, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
<p>Tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check failure on line 211 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 211, "column": 362}}}, "severity": "ERROR"}

Check warning on line 211 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 211, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
</div></td>
Expand All @@ -218,7 +218,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/t/carbon.super/api/identity/config-mgt/v1.0/search?$filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/t/carbon.super/api/identity/config-mgt/v1.0/search?filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>

Check failure on line 221 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 221, "column": 360}}}, "severity": "ERROR"}

Check warning on line 221 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 221, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
</div></td>
Expand All @@ -228,7 +228,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>

Check failure on line 231 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 231, "column": 384}}}, "severity": "ERROR"}

Check warning on line 231 in en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 231, "column": 331}}}, "severity": "WARNING"}
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Replace example basic-auth credentials with placeholders.

--user admin:admin should be changed to a non-sensitive placeholder value in documentation.

As per coding guidelines: "Use fenced code blocks with a language tag when known; keep code blocks focused and do not include secrets, tokens, passwords, or realistic keys."

🧰 Tools
🪛 Gitleaks (8.30.0)

[high] 231-231: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.

(curl-auth-user)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In
`@en/identity-server/6.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md`
at line 231, The curl example in the docs uses real-looking credentials ("--user
admin:admin"); replace them with a non-sensitive placeholder (e.g., "--user
<username>:<password>" or similar) in the example line containing the GET
request (the curl invocation showing /api/identity/config-mgt/v1.0/search) so no
secrets appear in the documentation and it conforms to the fenced-code-block
placeholder guideline.

</div>
</div>
</div></td>
Expand Down
10 changes: 5 additions & 5 deletions ...-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

The search context URL should be as follows:

` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query} `
` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query} `

Here, the value of ` {search-query} ` should be in the
form of a configuration management search query. For information on how
Expand Down Expand Up @@ -202,13 +202,13 @@
<p>Super tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check failure on line 205 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 205, "column": 344}}}, "severity": "ERROR"}

Check warning on line 205 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 205, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
<p>Tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check failure on line 211 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 211, "column": 362}}}, "severity": "ERROR"}

Check warning on line 211 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 211, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
</div></td>
Expand All @@ -218,7 +218,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/t/carbon.super/api/identity/config-mgt/v1.0/search?$filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/t/carbon.super/api/identity/config-mgt/v1.0/search?filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>

Check failure on line 221 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 221, "column": 360}}}, "severity": "ERROR"}

Check warning on line 221 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 221, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
</div></td>
Expand All @@ -228,7 +228,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>

Check failure on line 231 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 231, "column": 384}}}, "severity": "ERROR"}

Check warning on line 231 in en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 231, "column": 331}}}, "severity": "WARNING"}
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Please sanitize curl credentials in docs.

Use placeholders instead of admin:admin to avoid publishing credential-like values.

As per coding guidelines: "Use fenced code blocks with a language tag when known; keep code blocks focused and do not include secrets, tokens, passwords, or realistic keys."

🧰 Tools
🪛 Gitleaks (8.30.0)

[high] 231-231: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.

(curl-auth-user)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In
`@en/identity-server/6.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md`
at line 231, The curl example currently contains real-looking credentials
"admin:admin" in the command shown (the curl line with --user admin:admin);
update that example to use a neutral placeholder such as --user
<USERNAME>:<PASSWORD> or --user {USERNAME}:{PASSWORD} and ensure the snippet is
in a fenced code block with the appropriate language tag (e.g., bash) instead of
embedding credentials directly so no secret-like values appear in the docs.

</div>
</div>
</div></td>
Expand Down
10 changes: 5 additions & 5 deletions ...-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

The search context URL should be as follows:

` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query} `
` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query} `

Here, the value of ` {search-query} ` should be in the
form of a configuration management search query. For information on how
Expand Down Expand Up @@ -201,13 +201,13 @@
<p>Super tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check failure on line 204 in en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.

Raw Output:
{"message": "[WSO2-IAM.NoInformalAbbreviations] Use 'configuration' instead of 'config'. Avoid informal abbreviations in documentation.", "location": {"path": "en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 204, "column": 344}}}, "severity": "ERROR"}

Check warning on line 204 in en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 204, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
<p>Tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>

Check warning on line 210 in en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'https'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'https'?", "location": {"path": "en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md", "range": {"start": {"line": 210, "column": 292}}}, "severity": "WARNING"}
</div>
</div>
</div></td>
Expand All @@ -217,7 +217,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
</div>
</div>
</div></td>
Expand All @@ -227,7 +227,7 @@
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
</div>
Comment on lines +230 to 231
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Replace hardcoded basic-auth credentials in curl example.

The sample command includes --user admin:admin, which is a realistic password pattern and should be replaced with placeholders.

🔧 Suggested documentation-safe update 
-curl -k -v --user admin:admin GET 'https://localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29'
+curl -k -v --user <username>:<password> GET 'https://localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29'

As per coding guidelines: "Use fenced code blocks with a language tag when known; keep code blocks focused and do not include secrets, tokens, passwords, or realistic keys."

🧰 Tools
🪛 Gitleaks (8.30.0)

[high] 230-230: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.

(curl-auth-user)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In
`@en/identity-server/7.0.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md`
around lines 230 - 231, The curl example contains hardcoded credentials (--user
admin:admin); replace that with placeholders (e.g., --user
<USERNAME>:<PASSWORD>) or remove the --user flag and document using an auth
placeholder, and wrap the command in a fenced code block tagged with bash;
update the line containing the curl command string (the GET
'https://localhost:9443/api/identity/config-mgt/v1.0/search?...' example) to use
the placeholder credentials and proper fenced block formatting.

</div>
</div></td>
Expand Down
10 changes: 5 additions & 5 deletions ...-server/7.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ REST API allows you to perform cross-tenant search for resources.

The search context URL should be as follows:

` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query} `
` https://{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query} `

Here, the value of ` {search-query} ` should be in the
form of a configuration management search query. For information on how
Expand Down Expand Up @@ -202,13 +202,13 @@ for a URL. When you are trying out these scenarios, fill the {host},
<p>Super tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb1" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb1-1" title="1">https:<span class="co">//{host}:{port}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>
</div>
</div>
<p>Tenant:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?$filter={search-query}</span></a></code></pre></div>
<div class="sourceCode" id="cb2" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb2-1" title="1">https:<span class="co">//{host}:{port}/t/{tenant-domain}/api/identity/config-mgt/v1.0/search?filter={search-query}</span></a></code></pre></div>
</div>
</div>
</div></td>
Expand All @@ -218,7 +218,7 @@ for a URL. When you are trying out these scenarios, fill the {host},
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=tenantDomain eq ‘carbon.super’</span></a></code></pre></div>
</div>
</div>
</div></td>
Expand All @@ -228,7 +228,7 @@ for a URL. When you are trying out these scenarios, fill the {host},
<td><div class="content-wrapper">
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?$filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
<div class="sourceCode" id="cb4" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" title="1">curl -k -v --user admin:admin GET &#39;https:<span class="co">//localhost:9443/api/identity/config-mgt/v1.0/search?filter=%28tenantDomain%20eq%20%27carbon.super%27%29&#39;</span></a></code></pre></div>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Use placeholders instead of admin:admin in curl examples.

This still looks like hardcoded credentials and should be generalized to <username>:<password>.

As per coding guidelines: "Use fenced code blocks with a language tag when known; keep code blocks focused and do not include secrets, tokens, passwords, or realistic keys."

🧰 Tools
🪛 Gitleaks (8.30.0)

[high] 231-231: Discovered a potential basic authorization token provided in a curl command, which could compromise the curl accessed resource.

(curl-auth-user)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In
`@en/identity-server/7.1.0/docs/apis/retrieve-tenant-resources-based-on-search-parameters.md`
at line 231, Replace the hardcoded credentials in the curl example (the curl -k
-v --user admin:admin GET
'https://localhost:9443/api/identity/config-mgt/v1.0/search?...' line) with a
placeholder like <username>:<password> and ensure the example is presented as a
fenced code block (bash) without real secrets; update the --user argument only
and keep the rest of the curl invocation unchanged.

</div>
</div>
</div></td>
Expand Down
Loading
Loading