Skip to content

Latest commit

 

History

History
252 lines (160 loc) · 5.57 KB

File metadata and controls

252 lines (160 loc) · 5.57 KB

\HealthAPI

All URIs are relative to https://api.ecuapi.com

Method HTTP request Description
GetApiInfo Get /health Basic health check
GetApiInfo_0 Get /v1/health Basic health check
GetDetailedHealth Get /health/health Detailed health check
GetDetailedHealth_0 Get /v1/health/health Detailed health check

GetApiInfo

HealthResponse GetApiInfo(ctx).Execute()

Basic health check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HealthAPI.GetApiInfo(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.GetApiInfo``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApiInfo`: HealthResponse
	fmt.Fprintf(os.Stdout, "Response from `HealthAPI.GetApiInfo`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetApiInfoRequest struct via the builder pattern

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetApiInfo_0

HealthResponse GetApiInfo_0(ctx).Execute()

Basic health check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HealthAPI.GetApiInfo_0(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.GetApiInfo_0``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApiInfo_0`: HealthResponse
	fmt.Fprintf(os.Stdout, "Response from `HealthAPI.GetApiInfo_0`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetApiInfo_1Request struct via the builder pattern

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDetailedHealth

HealthResponse GetDetailedHealth(ctx).Execute()

Detailed health check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HealthAPI.GetDetailedHealth(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.GetDetailedHealth``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDetailedHealth`: HealthResponse
	fmt.Fprintf(os.Stdout, "Response from `HealthAPI.GetDetailedHealth`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetDetailedHealthRequest struct via the builder pattern

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDetailedHealth_0

HealthResponse GetDetailedHealth_0(ctx).Execute()

Detailed health check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HealthAPI.GetDetailedHealth_0(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.GetDetailedHealth_0``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDetailedHealth_0`: HealthResponse
	fmt.Fprintf(os.Stdout, "Response from `HealthAPI.GetDetailedHealth_0`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetDetailedHealth_2Request struct via the builder pattern

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]