swagger-api / swagger-api/swagger-ui

v5 useSyncExternalStore2 error with simple usage in Vue3 application

Open
#10,074 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: [e.g. macOS]
  • Browser: [e.g. chrome, safari]
  • Version: [e.g. 22]
  • Method of installation: [e.g. npm, dist assets]
  • Swagger-UI version: [e.g. 3.10.0]
  • Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
Content & configuration

Swagger/OpenAPI definition:

https://raw.githubusercontent.com/SmartAPI/smartapi_registry/update_metadata/SmartAPI/smartapi_openapi.yml

Swagger-UI configuration options:

SwaggerUI({
  url: dataurl,
  dom_id: '#swagger-ui',
})
?yourQueryStringConfig
Screenshots
How can we help?

In a Vue application I could run the older v4 version but the latest v5 gives me an error related to React I think, what's causing this?
We need the UI to render openapi 3.1 specs and v4 doesn't do it anymore.

Screenshot 2024-07-10 at 1 54 21 PM

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported Vue application setup with Swagger-UI v5, using the provided SmartAPI OpenAPI definition and the shown SwaggerUI configuration. Inspect the useSyncExternalStore2 error and compare behavior with v4. Done means identifying the v5 compatibility cause and documenting or fixing the path to render the OpenAPI 3.1 specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi, react
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.