diff --git a/README.md b/README.md index a353f04eed23c8c22b94919c06b142ec99d62ceb..70c299c2f26db5f4a0b7bbdfc6917490c8890013 100644 --- a/README.md +++ b/README.md @@ -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 ```