Skip to content
Snippets Groups Projects
Commit 2208264a authored by Benjamin Leendert Montavon's avatar Benjamin Leendert Montavon
Browse files

Update README.md

parent 12f950f4
Branches
No related tags found
No related merge requests found
......@@ -7,12 +7,12 @@ To view the schema, you can use any tool that supports the OpenAPI specification
This also works with GitLab's integrated Swagger-Editor.
## Contributing
To contribute, you can use any editor and edit the files in the folder *OpenAPI*. We recommend Visual Studio Code with the OpenAPI extension.
To contribute, you can use any editor and edit the files in the folder *src*. We recommend Visual Studio Code with the OpenAPI extension.
Please adhere to the filestructure which decomposes resources into individual files.
## Bundling
To bundle the files to the public `openapi.yml` file, you can use `swagger-cli`:
```
npm install -g swagger-cli
npx swagger-cli bundle .\OpenAPI\openapi.yml -o .\public\openapi.yml -r -t yaml
npx swagger-cli bundle .\src\openapi.yml -o .\public\openapi.yml -r -t yaml
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment