swagger-api / swagger-api/swagger-ui

Type declarations for the swagger-ui project

Open
#5,946 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the solution you'd like

Types are provided in DefinitelyTyped: @types/swagger-ui-react and @types/swagger-ui-dist, but not @types/swagger-ui. Is there a reason for this?

Additional context

I'd like to use swagger-ui in an SPA, but the react component is too limited for our use case.

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

No repository files or tests are named in the issue. Start by comparing the existing @types/swagger-ui-react and @types/swagger-ui-dist declarations, then inspect how the non-React swagger-ui package is consumed in an SPA. Done means a usable @types/swagger-ui package provides declarations for the project’s public API.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.