Skip to content

Fix issue with credential management API docs#5892

Merged
himeshsiriwardana merged 1 commit intowso2:masterfrom
NipuniBhagya:master
Feb 16, 2026
Merged

Fix issue with credential management API docs#5892
himeshsiriwardana merged 1 commit intowso2:masterfrom
NipuniBhagya:master

Conversation

@NipuniBhagya
Copy link
Contributor

@NipuniBhagya NipuniBhagya commented Feb 16, 2026

Purpose

This pull request updates the way API documentation files reference their OpenAPI specification URLs. The changes ensure that the URLs are dynamically generated using the base_path variable, which improves maintainability and flexibility when deploying the documentation to different environments.

API documentation improvements:

  • Updated the spec-url in the end-user-credential-management-rest-api.md file to use the base_path variable for constructing the OpenAPI spec URL.
  • Updated the spec-url in the organization-apis/end-user-credential-management-rest-api.md file to use the base_path variable for constructing the OpenAPI spec URL.ue1, issue2, etc. -->

Related PRs

Test environment

Security checks

Summary by CodeRabbit

  • Documentation
    • Updated API specification URL references in end-user credential management documentation to improve consistency.
    • Enhanced URL configuration for API specification access across documentation pages.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


Walkthrough

Two documentation files update OpenAPI specification URL references from relative paths to a base_path variable pattern, enabling consistent URL resolution across different documentation contexts.

Changes

Cohort / File(s) Summary
OpenAPI Spec URL Refactoring
en/asgardeo/docs/apis/end-user-credential-management-rest-api.md, en/asgardeo/docs/apis/organization-apis/end-user-credential-management-rest-api.md
Replaced hardcoded relative paths with {{base_path}} variable in Redoc spec-url attributes for end-user credential management OpenAPI specifications, standardizing URL construction across documentation files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hop, hop! The URLs now shine bright,
With base_path variables set just right,
No more relatives lost in the maze,
Our specs resolve in consistent ways! ✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating credential management API documentation to use dynamic base_path variables for spec URLs.
Description check ✅ Passed The description covers the Purpose section with clear explanation of changes and their benefits. Related PRs, Test environment, and Security checks sections are present but empty/unchecked as applicable for documentation-only changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

@himeshsiriwardana himeshsiriwardana merged commit c45e235 into wso2:master Feb 16, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants