upstream-ory-keto/oryx/healthx/doc.go

// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0

// Package healthx providers helpers for returning health status information via HTTP.
package healthx

import "strings"

// The health status of the service.
//
// swagger:model healthStatus
type swaggerHealthStatus struct {
	// Status always contains "ok".
	Status string `json:"status"`
}

// The not ready status of the service.
//
// swagger:model healthNotReadyStatus
type swaggerNotReadyStatus struct {
	// Errors contains a list of errors that caused the not ready status.
	Errors map[string]string `json:"errors"`
}

func (s swaggerNotReadyStatus) Error() string {
	var errs []string
	for _, err := range s.Errors {
		errs = append(errs, err)
	}
	return strings.Join(errs, "; ")
}

// swagger:model version
type swaggerVersion struct {
	// Version is the service's version.
	Version string `json:"version"`
}