Merge pull request #134 from qase-tms/report-specs

Changed folder structure and some cleanup

.github/workflows/readme.yaml

@@ -19,7 +19,7 @@ jobs:
 
       - uses: readmeio/rdme@v8
         with:
-          rdme: openapi ./api.yaml --key=${{ secrets.README_KEY }} --id=6172e1f931427d3f983e34ff
+          rdme: openapi ./testops-api/api.yaml --key=${{ secrets.README_KEY }} --id=6172e1f931427d3f983e34ff
 
       - uses: rtCamp/action-slack-notify@v2
         env:

README.md

@@ -1,31 +1,7 @@
-> # 📑 Qase API Specification
-> 
-> Based on [OpenAPI](https://en.wikipedia.org/wiki/OpenAPI_Specification) specifications.
+# General
 
-## Useful documentations
+This repository contains specification files for the following Qase Products:
 
-- [OpenAPI Initiative](https://www.openapis.org).
-- [OpenAPI Specification](https://swagger.io/specification/).
-- [Swagger Documentation](https://swagger.io/docs/).
-
-## Useful resources
-
-- [OpenAPI Tools](https://github.com/OpenAPITools).
-  - [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli).
-- [Swagger at GitHub](https://github.com/swagger-api).
-  - [Swagger Codegen](https://github.com/swagger-api/swagger-codegen).
-  - [Swagger UI](https://github.com/swagger-api/swagger-ui).
-- [ReadMe at GitHub](https://github.com/readmeio).
-  - [rdme](https://github.com/readmeio/rdme).
-- [Redocly](https://github.com/Redocly).
-  - [ReDoc](https://github.com/Redocly/redoc).
-- [API Dev Tools](https://github.com/APIDevTools).
-  - [swagger-cli](https://github.com/APIDevTools/swagger-cli).
-- Templates
-  - [OpenAPI Boilerplate](https://github.com/dgarcia360/openapi-boilerplate).
-  - [OpenAPI Definition Starter](https://github.com/Redocly/openapi-starter).
-
-## Useful articles
-
-- [How to split a large OpenAPI document into multiple files](https://davidgarcia.dev/posts/how-to-split-open-api-spec-into-multiple-files/).
-do
+1. [Qase TestOps API](./testops-api/README.md)
+2. [Qase Report](./report/README.md)
+3. [Qase Report UI](./report-ui/README.md)