swagger-api / swagger-api/swagger-ui
Docker URLS with query parameters &
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Using Swagger UI on Docker
Configuration:
name: API_URLS
value: >-
[
{url:'/swagger-ui/file-example/local.example.yml',name:'Local Example'},
{url:'https://gitlab.xxx.yyy/api/v4/projects/11163/repository/files/service-service%2FEntitie.yaml/raw?private_token=zzzz&ref=master',name:'service-boundary'}
]
When i access to the swagger ui i see this error:
https://gitlab.xxx.yyy/api/v4/projects/11163/repository/files/service-service%2FEntitie.yaml/raw?private_token=zzzzurl: "./local.example.yml",ref=master
Q&A (please complete the following information)
- OS: Dokcer Kubernetes
- Browser: Chrome
- Version: swaggerapi/swagger-ui:v3.14.2
- Method of installation: Docker
- Swagger-UI version: 3.14.2
- Swagger/OpenAPI version: OpenAPI 3.0
Seems to be an error when parsing the urls to build the list
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the API_URLS configuration from the issue with Swagger UI v3.14.2 in Docker and inspect how the URL list is parsed. Confirm that the GitLab URL preserves the encoded ampersand and query parameters while the local example remains separate; done means both entries load with their intended URLs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100