Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var APIKeyAuth = APIKeySecurity("api_key", func() {
Scope("api:read", "Read-only access")
})
APIKeyAuth defines our security scheme
View Source
var BaseHealthResponse = Type("BaseHealthResponse", func() {
Description("Base response of Health API.")
Field(1, "s", String, func() {
Description("Status of the response.")
Example("error")
Enum(
"ok",
"error",
"no_data",
)
})
Field(2, "errmsg", String, func() {
Description("Error message.")
Example("Something has failed")
})
})
View Source
var HealthStatus = Type("HealthStatus", func() {
Description("Status defines the structure for health information")
})
View Source
var HealthStatusResponse = Type("HealthStatusResponse", func() { Reference(BaseHealthResponse) Field(1, "s") Field(2, "errmsg") Field(3, "data", HealthStatus) Field(4, "status") Required("s", "status") })
View Source
var ProbeResponse = Type("ProbeResponse", func() {
Field(1, "result", String, func() {
Description("Result of the probe")
})
Required(
"result",
)
})
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.