Skip to content

Conversation

Abhyshekbhalaji
Copy link

@Abhyshekbhalaji Abhyshekbhalaji commented Oct 10, 2025

Description

This change ensures that example objects in request schemas are displayed as standard JSON in Swagger UI, rather than with Immutable.js prefixes like OrderedMap.

Motivation and Context

This change fix Swagger UI would display Immutable.js type prefixes in example fields that would confuse the api users.

Fixes #10535

How Has This Been Tested?

I did manually tested with arrays and objects in req schema in localhost server.

Screenshots (if appropriate):

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • All new and existing tests passed.

Test cases that can prove the fix is not breakable

image image image

@glowcloud
Copy link
Contributor

Hi @Abhyshekbhalaji,

Thanks for your contribution! Unfortunately, your changes are not related to schema rendering, so they do not address the related issue. I will be closing this PR, as another solution has been proposed.

@glowcloud glowcloud closed this Oct 13, 2025
@Abhyshekbhalaji Abhyshekbhalaji deleted the main branch October 13, 2025 08:03
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.

Title: example field in request schema renders incorrectly with OrderedMap prefixes in Swagger UI

2 participants