Skip to content

Conversation

BimsaraBodaragama
Copy link
Member

@BimsaraBodaragama BimsaraBodaragama commented Oct 17, 2025

Purpose

Add a temporary public note in the OAuth2 Dynamic Client Registration (DCR) API [1] documentation to inform users about the upcoming behavioral change where null fields will be omitted from the DCR API response [2], in alignment with REST best practices.

Goals

  • Display a clear notice in the DCR API documentation indicating the upcoming change.
  • Provide users with a grace period to adapt before the change becomes effective.
  • Ensure visual consistency in the documentation using inline HTML for Redoc compatibility.

Approach

  • Added a yellow-highlighted HTML note block under the info.description section of oauth-dcr.yaml.
  • The note communicates the deprecation timeline and aligns with REST response formatting standards.
  • Verified Markdown and HTML rendering without warnings.

NOTE:
The current behavior of returning null fields will remain temporarily enabled until May 1, 2026, providing a grace period for users to adapt, and will be updated to omit null in DCR response after the grace period [3] [4].
After the grace period, this notice should be removed, and it has been tracked via [5] [6].

Related Issues


@BimsaraBodaragama BimsaraBodaragama self-assigned this Oct 17, 2025
@BimsaraBodaragama
Copy link
Member Author

BimsaraBodaragama commented Oct 17, 2025

✅ Fix Verification

The update was verified locally in both dark and light modes of the Asgardeo Docs site to ensure consistent rendering and readability.

Dark Mode Preview

image

Light Mode Preview

image

The note renders correctly with left shading and inline code formatting in both themes, confirming that the change displays as intended.

@himeshsiriwardana himeshsiriwardana merged commit 724d0f7 into wso2:master Oct 20, 2025
1 of 2 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