# README
Go API Server for kubechat
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Overview
This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.
To see how to make this your own, look here:
- API version: 1.0.0
- Build date: 2020-05-09T23:48:28.972147-07:00[America/Los_Angeles]
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 kubechat .
Once the image is built, just run
docker run --rm -it kubechat
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 for more information.
A workaround is to manually update the path and handler. Please refer to gin-gonic/gin/issues/205#issuecomment-296155497 for more information.
# Functions
Index is the index handler.
NewRouter returns a new router.
RunKubectl godoc @Summary execute kubectl command @Description get kubernetes objects with kubectl @Produce json @Success 200 {object} CmdOutput @Router /kubectl [get] @Param cmd query string true "use by kubectl".
# Type aliases
Routes is the list of the generated Route.