swagger-api / swagger-api/swagger-ui
Where is "the project root directory"?
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)
- Browser: chrome
- Method of installation: docker image
- Swagger-UI version: v3.19.3
- Swagger/OpenAPI version: OpenAPI 3.0
How can we help?
I am trying to run the swagger UI docker image locally and pass in a config file so that I can test out config changes. In the swagger UI documentation one of the options mentioned for passing in a config file is to give it a config file in the project root directory:
https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
Specifically in the swagger UI docker image, where is the project root directory? Would this be the same folder wherever the API doc is, b/c that doesn't seem to be right? Is it in the /usr/share/nginx/html folder?
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 with the Swagger UI configuration documentation linked in the issue and the Docker image layout, checking the referenced /usr/share/nginx/html path and how a config file is passed to the container. Done means the documentation clearly identifies the project root directory for the Docker image and explains where the config file should be placed or mounted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, javascript
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100