ref: 876360f046a2ffb85b1471b7a13bbea799acdfde
server/grafana/README.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# Go API Server for openapi API definition for the Grafana plugin simpod json datasource https://github.com/simPod/grafana-json-datasource ## Overview This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. - To see how to make this your own, look here: [README](https://openapi-generator.tech) - API version: 0.1 - Build date: 2024-08-02T00:52:32.279604829+02:00[Europe/Stockholm] - Generator version: 7.7.0 ### Running the server To run the server, follow these simple steps: ``` go run main.go ``` To run the server in a docker container ``` docker build --network=host -t openapi . ``` Once the image is built, just run ``` docker run --rm -it openapi ``` ### Known Issue Endpoints sharing a common path may result in issues. For example, `/v2/pet/findByTags` and `/v2/pet/:petId` will result in an issue with the Gin framework. For more information about this known limitation, please refer to [gin-gonic/gin#388](https://github.com/gin-gonic/gin/issues/388) for more information. A workaround is to manually update the path and handler. Please refer to [gin-gonic/gin/issues/205#issuecomment-296155497](https://github.com/gin-gonic/gin/issues/205#issuecomment-296155497) for more information. |