Skip to content

Conversation

@scottohara
Copy link
Contributor

Description

The setExpanded() and setCollapsed() callbacks were missing pathMutator in the useCallback() dependency array, meaning that there was a race condition on initial render when configured with defaultModelRendering: "model".

Switching from Schema -> Example Value -> Schema worked around the issue, but this PR fixes it so that the schema expansion works on first render without the workaround.

Motivation and Context

Fixes #10628

How Has This Been Tested?

Manually tested in local dev server by configuring the dev-helper-initializer.js file as follows:

const ui = SwaggerUIBundle({
  url: "https://gist.githubusercontent.com/seriousme/55bd4c8ba2e598e416bb5543dcd362dc/raw/cf0b86ba37bb54bf1a6bf047c0ecf2a0ce4c62e0/petstore-v3.1.json",
  defaultModelRendering: "model",

Also added an e2e test to ensure that the expand collapse works on initial render.

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.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests 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.

Response model expand/collapse does not work on initial render with OAS 3.1

1 participant