Skip to content

Add user discoverable application API documentation#6273

Merged
KD23243 merged 1 commit into
wso2:masterfrom
KD23243:addDiscoverableAppApiDocs
Jul 17, 2026
Merged

Add user discoverable application API documentation#6273
KD23243 merged 1 commit into
wso2:masterfrom
KD23243:addDiscoverableAppApiDocs

Conversation

@KD23243

@KD23243 KD23243 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Purpose

Add the REST API reference documentation for the User Application Management API (user-discoverable applications) in the Asgardeo documentation. This documents the endpoints that let an authenticated user list the applications discoverable to them and retrieve a single application by ID.

Related Issue

  • N/A

Implementation

  • Added the OpenAPI specification en/asgardeo/docs/apis/restapis/discoverable-application.yaml covering the GET /me/applications and GET /me/applications/{applicationId} endpoints, including request parameters, response schemas, and error responses.
  • Added the Redoc rendering page en/asgardeo/docs/apis/user-discoverable-applications.md.
  • Added a navigation entry for the new page under the APIs section in en/asgardeo/mkdocs.yml.

@coderabbitai

coderabbitai Bot commented Jul 17, 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: 57a578fd-e56d-4549-9e0f-6f5e87ea37fa

📥 Commits

Reviewing files that changed from the base of the PR and between 894f13c and ce569fd.

📒 Files selected for processing (3)
  • en/asgardeo/docs/apis/restapis/discoverable-application.yaml
  • en/asgardeo/docs/apis/user-discoverable-applications.md
  • en/asgardeo/mkdocs.yml

📝 Walkthrough

Walkthrough

Summary

Adds an OAuth2-secured OpenAPI specification for listing and retrieving user applications, defines reusable request and response contracts, and publishes the specification through a Redoc page linked in MkDocs navigation.

Changes

User discoverable application API

Layer / File(s) Summary
OpenAPI foundation and OAuth2 security
en/asgardeo/docs/apis/restapis/discoverable-application.yaml
Defines the OpenAPI metadata, server URL template, global OAuth2 authorization-code security, and internal_login scope.
Application endpoints and reusable contracts
en/asgardeo/docs/apis/restapis/discoverable-application.yaml
Documents getApplications and getApplication, reusable query parameters and status responses, application response schemas, navigation links, and structured errors.
Redoc page and site navigation
en/asgardeo/docs/apis/user-discoverable-applications.md, en/asgardeo/mkdocs.yml
Adds a Redoc page for the specification and links it under “End User APIs”.

Suggested labels: Team/User & identity administration, Team/API Access Mgt & Authorization

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers purpose and implementation, but it misses required template sections for related PRs, test environment, and security checks. Add the missing template sections for Related PRs, Test environment, and Security checks, and ensure the related-issue/PR references match the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for the user discoverable application API.
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.

@KD23243
KD23243 merged commit 12f3762 into wso2:master Jul 17, 2026
5 checks passed
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