System API
System API documentation for Go SDK
All URIs are relative to http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| GetSystemInfo | Get /v1/system/info | Retrieve server build metadata |
| InitializeSystem | Post /v1/system/init | Initialize the system |
GetSystemInfo
SystemInfoResponse GetSystemInfo(ctx).Execute()
Retrieve server build metadata
Example
package main
import (
"context"
"fmt"
"os"
goodmem_client "github.com/PAIR-Systems-Inc/goodmem/clients/go"
)
func main() {
configuration := goodmem_client.NewConfiguration()
apiClient := goodmem_client.NewAPIClient(configuration)
resp, r, err := apiClient.SystemAPI.GetSystemInfo(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemAPI.GetSystemInfo``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSystemInfo`: SystemInfoResponse
fmt.Fprintf(os.Stdout, "Response from `SystemAPI.GetSystemInfo`: %v\n", resp)
}Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetSystemInfoRequest struct via the builder pattern
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
↑ Back to Go SDK ↑ Back to Go SDK ↑ Back to Go SDK
InitializeSystem
SystemInitResponse InitializeSystem(ctx).Body(body).Execute()
Initialize the system
Example
package main
import (
"context"
"fmt"
"os"
goodmem_client "github.com/PAIR-Systems-Inc/goodmem/clients/go"
)
func main() {
body := map[string]interface{}{ ... } // map[string]interface{} | Empty request body - no parameters required (optional)
configuration := goodmem_client.NewConfiguration()
apiClient := goodmem_client.NewAPIClient(configuration)
resp, r, err := apiClient.SystemAPI.InitializeSystem(context.Background()).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SystemAPI.InitializeSystem``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `InitializeSystem`: SystemInitResponse
fmt.Fprintf(os.Stdout, "Response from `SystemAPI.InitializeSystem`: %v\n", resp)
}Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiInitializeSystemRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| body | map[string]interface | Empty request body - no parameters required |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json