Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SwaggerUI@v4: integrate latest beta release of swagger-client #8401

Closed
1 of 2 tasks
char0n opened this issue Feb 22, 2023 · 3 comments
Closed
1 of 2 tasks

SwaggerUI@v4: integrate latest beta release of swagger-client #8401

char0n opened this issue Feb 22, 2023 · 3 comments
Assignees
Labels
dependencies Pull requests that update a dependency file type: enhancement version: 4.x

Comments

@char0n
Copy link
Member

char0n commented Feb 22, 2023

The goal of this issue is to integrate latest beta version of swagger-client with OpenAPI 3.1.0 support with SwaggerUI@v4 release channel.

Latest version of swagger-client containing OpenAPI 3.1.0 is https://www.npmjs.com/package/swagger-client/v/3.19.0-beta.7.

Reason why we want to do it, is to provide feedback for swagger-client@3.19.0-beta.* and make sure it's fully backwards compatible. After it proves to be working correctly, we'll be able to move swagger-client@3.19.0 to stable release channel.

There should be no increase in bundle size as from swagger-client >=3.19.0-beta.6 was refactored in a way to allow proper tree-shaking. As SwaggerUI@v4 doesn't need OpneAPI 3.1.0 support, it will not be part of resulting bundle.

NOTE: Integration of swagger-client >=3.19.0-beta.6 resulted in smaller SwaggerUI@v4 bundles than before. This means that utilizing swagger-client versions with OpenAPI 3.1.0 support and ApiDOM integration, doesn't make SwaggerUI@v4 bundles any bigger (actually smaller).

TODO:

@char0n char0n self-assigned this Feb 22, 2023
@char0n char0n added version: 4.x type: enhancement dependencies Pull requests that update a dependency file labels Feb 22, 2023
char0n added a commit that referenced this issue Feb 23, 2023
@char0n
Copy link
Member Author

char0n commented Feb 23, 2023

After integrating swagger-client@3.19.0-beta.6, there has been been slight decrease of bundle sizes, due to work that has been done in: swagger-api/swagger-js@2a39fb4

Before

-rw-rw-r--  1 char0n char0n     539 Dec  2 17:00 swagger-initializer.js
-rw-rw-r--  1 char0n char0n 1061579 Nov  9 09:28 swagger-ui-bundle.js
-rw-rw-r--  1 char0n char0n 1540291 Nov  9 09:28 swagger-ui-bundle.js.map
-rw-rw-r--  1 char0n char0n  144966 Nov  9 09:28 swagger-ui.css
-rw-rw-r--  1 char0n char0n  251179 Nov  9 09:28 swagger-ui.css.map
-rw-rw-r--  1 char0n char0n  368776 Nov  9 09:28 swagger-ui-es-bundle-core.js
-rw-rw-r--  1 char0n char0n 1251201 Nov  9 09:28 swagger-ui-es-bundle-core.js.map
-rw-rw-r--  1 char0n char0n 1061347 Nov  9 09:28 swagger-ui-es-bundle.js
-rw-rw-r--  1 char0n char0n 1536163 Nov  9 09:28 swagger-ui-es-bundle.js.map
-rw-rw-r--  1 char0n char0n  256576 Nov  9 09:28 swagger-ui.js
-rw-rw-r--  1 char0n char0n  281363 Nov  9 09:28 swagger-ui.js.map
-rw-rw-r--  1 char0n char0n  312217 Nov  9 09:28 swagger-ui-standalone-preset.js
-rw-rw-r--  1 char0n char0n  493648 Nov  9 09:28 swagger-ui-standalone-preset.js.map

After

-rw-rw-r--  1 char0n char0n     539 Dec  2 17:00 swagger-initializer.js
-rw-rw-r--  1 char0n char0n 1044927 Feb 23 12:14 swagger-ui-bundle.js
-rw-rw-r--  1 char0n char0n 1510928 Feb 23 12:14 swagger-ui-bundle.js.map
-rw-rw-r--  1 char0n char0n  144966 Nov  9 09:28 swagger-ui.css
-rw-rw-r--  1 char0n char0n  251179 Nov  9 09:28 swagger-ui.css.map
-rw-rw-r--  1 char0n char0n  369043 Feb 23 12:14 swagger-ui-es-bundle-core.js
-rw-rw-r--  1 char0n char0n 1252688 Feb 23 12:14 swagger-ui-es-bundle-core.js.map
-rw-rw-r--  1 char0n char0n 1044695 Feb 23 12:14 swagger-ui-es-bundle.js
-rw-rw-r--  1 char0n char0n 1506655 Feb 23 12:14 swagger-ui-es-bundle.js.map
-rw-rw-r--  1 char0n char0n  256577 Feb 23 12:14 swagger-ui.js
-rw-rw-r--  1 char0n char0n  281358 Feb 23 12:14 swagger-ui.js.map
-rw-rw-r--  1 char0n char0n  322989 Feb 23 12:14 swagger-ui-standalone-preset.js
-rw-rw-r--  1 char0n char0n  513981 Feb 23 12:14 swagger-ui-standalone-preset.js.map

char0n added a commit that referenced this issue Feb 23, 2023
CD pipeline is currently implemented in Jenkins,
and is no longer able to run the tests during the
release process, thus rendering the Jenkins CD
pipeline unable to issue a new release.

THis change disables running e2e tests before
the release.

CI pipeline implemented in GitHub Actions
guarantees that master is always releasable.

Refs #8401
char0n added a commit that referenced this issue Feb 24, 2023
@char0n
Copy link
Member Author

char0n commented Feb 24, 2023

@char0n
Copy link
Member Author

char0n commented Mar 1, 2023

@char0n char0n closed this as completed Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file type: enhancement version: 4.x
Projects
None yet
Development

No branches or pull requests

1 participant