bottin-ag/apiresponse/apiresponse.go

39 lines
711 B
Go
Raw Permalink Normal View History

// Package apiresponse provides response types for API routes
package apiresponse
// Response defines the basic response types fields
type Response struct {
Error string
Message string
StatusCode int
}
2023-09-16 23:21:27 -04:00
type Responder interface {
Respond() Responder
}
func (r Response) Respond() Responder {
return r
}
// HealthGET is the response type for `GET /v:version/health/ http/1.1`
type HealthGET struct {
Response
Data struct {
BottinStatus string
}
}
// ScanGET is the response type for `GET /v:version/scan/ http/1.1`
type ScanGET struct {
Response
Data struct {
IsScanned bool
}
}
// ScanPOST is the response type for `POST /v:version/scan/ http/1.1`
type ScanPOST struct {
Response
}