All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetVersion | Get /version | Return Running Software Version. |
| IsAlive | Get /health/alive | Check HTTP Server Status |
| IsReady | Get /health/ready | Check HTTP Server and Database Status |
| Prometheus | Get /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
InlineResponse2001 GetVersion(ctx).Execute()
Return Running Software Version.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.GetVersion(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.GetVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetVersion`: InlineResponse2001
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.GetVersion`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiGetVersionRequest struct via the builder pattern
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 IsAlive(ctx).Execute()
Check HTTP Server Status
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.IsAlive(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsAlive``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IsAlive`: InlineResponse200
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsAlive`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiIsAliveRequest struct via the builder pattern
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 IsReady(ctx).Execute()
Check HTTP Server and Database Status
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.IsReady(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsReady``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IsReady`: InlineResponse200
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsReady`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiIsReadyRequest struct via the builder pattern
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Prometheus(ctx).Execute()
Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.Prometheus(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.Prometheus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiPrometheusRequest struct via the builder pattern
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]