Skip to content

Fix BEARER authentication example in Update Action documentation - #6279

Open
monilkarajapaksha wants to merge 1 commit into
wso2:masterfrom
monilkarajapaksha:fix-issue-28198
Open

Fix BEARER authentication example in Update Action documentation#6279
monilkarajapaksha wants to merge 1 commit into
wso2:masterfrom
monilkarajapaksha:fix-issue-28198

Conversation

@monilkarajapaksha

Copy link
Copy Markdown

Purpose

This PR fixes an inconsistency in the Update Action API documentation for the BEARER authentication configuration.

The AuthenticationType schema documents the BEARER authentication property as accessToken, while the request payload example uses token. This inconsistency can confuse developers when constructing the request payload.

This PR updates the request payload example to use the same property name as the AuthenticationType schema, ensuring consistency throughout the documentation.

Resolves
#28198

Related PRs

None.


Test environment

Documentation change only. No code changes or runtime testing required.


Security checks

@CLAassistant

CLAassistant commented Jul 19, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: af42676d-4bbd-4a4d-bb43-8755407a8724

📥 Commits

Reviewing files that changed from the base of the PR and between 46ed099 and 68c14a9.

📒 Files selected for processing (1)
  • en/identity-server/7.3.0/docs/apis/restapis/actions.yaml

📝 Walkthrough

Walkthrough

Changes

Authentication example

Layer / File(s) Summary
Update Bearer property example
en/identity-server/7.3.0/docs/apis/restapis/actions.yaml
The preIssueAccessToken PATCH request example now uses accessToken instead of token for the Bearer authentication property.

Possibly related issues

  • wso2/product-is#28198 — Tracks the same Bearer authentication example correction from token to accessToken.

Suggested labels: Team/Authentication & registration

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation fix for the BEARER authentication example.
Description check ✅ Passed The description includes the required Purpose, Related PRs, Test environment, and Security checks sections with relevant details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants