add openapi specifications

UST-QuAntiL · Mar 8, 2024 · edc8f3b · edc8f3b
1 parent 78ccf10
commit edc8f3b
Show file tree

Hide file tree

Showing 3 changed files with 1,434 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,10 @@ Now the qiskit-service is available on http://localhost:5013/.
 The qiskit-service provides a Swagger UI, specifying the request schemas and showcasing exemplary requests for all API endpoints.
 * http://localhost:5013/api/swagger-ui
 
+The OpenAPI specifications are also statically available:
+[OpenAPI JSON](./docs/api/openapi.json)  
+[OpenAPI YAML](./docs/api/openapi.yaml)
+
 _Note_: To run the setup as a developer, see [here](./docs/dev/run-as-dev.md).
 
 ## Using IonQ QPUs