Skip to content

Conversation

@tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Feb 15, 2023

Description

  • update EditorPreviewWrapper to render SwaggerUI if definition is OpenAPI3.1. Previously would render a fallback component
  • update swagger-ui-react dependency

Motivation and Context

swagger-ui@4.16.0-alpha.3 and swagger-ui-react@4.16.0-alpha.3 now supports OpenAPI 3.1 via apidom

How Has This Been Tested?

local

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.
  • 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.

@tim-lai tim-lai changed the title feat(oas3): integrate swagger-ui containing openapi3.1 support feat(oas3.1): integrate swagger-ui containing OpenAPI3.1 support Feb 15, 2023
@tim-lai
Copy link
Contributor Author

tim-lai commented Feb 16, 2023

@char0n Any thoughts why CI is getting an out of memory error during the build step? Could it be the overrides in package.json? Although, it builds fine on my local.

@tim-lai
Copy link
Contributor Author

tim-lai commented Feb 16, 2023

Just saw the note for swagger-client@beta, which this PR still uses swagger-client@alpha. Not sure if relevant yet.

@char0n
Copy link
Contributor

char0n commented Feb 16, 2023

I know where the issue is. It's documented in #3856 and I'll process it during tomorrow. After it's done, I'll create PR which will supersede this PR.

@char0n
Copy link
Contributor

char0n commented Feb 21, 2023

Superseded by #3872

@char0n char0n closed this Feb 21, 2023
char0n added a commit that referenced this pull request Mar 10, 2023
Rendering of OpenAPI 3.1.0 is provided by integration of SwaggerUI@5
with partial experimental OpenAPI 3.1.0 support.

Refs #3877 
Refs #3854
Closes #3931
Closes #3929
Closes #3926
swagger-bot pushed a commit that referenced this pull request Mar 10, 2023
# [5.0.0-alpha.51](v5.0.0-alpha.50...v5.0.0-alpha.51) (2023-03-10)

### Features

* render OpenAPI 3.1.0 definitions in preview pane ([#3872](#3872)) ([c72c422](c72c422)), closes [#3877](#3877) [#3854](#3854) [#3931](#3931) [#3929](#3929) [#3926](#3926)
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