internal/httpclient/docs/MetadataAPI.md
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 |
GetVersion200Response GetVersion(ctx).Execute()
Return Running Software Version.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ory/hydra-client-go/v2"
)
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`: GetVersion200Response
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
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HealthStatus IsAlive(ctx).Execute()
Check HTTP Server Status
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ory/hydra-client-go/v2"
)
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`: HealthStatus
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
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IsReady200Response IsReady(ctx).Execute()
Check HTTP Server and Database Status
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ory/hydra-client-go/v2"
)
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`: IsReady200Response
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
[Back to top] [Back to API list] [Back to Model list] [Back to README]