http

Documentation

Index

• Constants
• func WriteHTTPErrorResponse(rw http.ResponseWriter, err error)
• func WriteJSON(rw http.ResponseWriter, data interface{}) error
• func WritePagingResponse(rw http.ResponseWriter, req *http.Request, data interface{}) error
• type ErrorResponse
• type PagePagingResponse
• type PageResponse

Constants

const (
	DefaultPageSize = "100"
)

Functions

func WriteHTTPErrorResponse

func WriteHTTPErrorResponse(rw http.ResponseWriter, err error)

func WriteJSON

func WriteJSON(rw http.ResponseWriter, data interface{}) error

func WritePagingResponse

func WritePagingResponse(rw http.ResponseWriter, req *http.Request, data interface{}) error

Types

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message" example:"error message"`
	Code    string `json:"code,omitempty" example:"IR001"`
}

type PagePagingResponse

type PagePagingResponse struct {
	Previous string `json:"previous,omitempty" example:"https://quorum-key-manager.com/stores/your-store/secrets?page=1"`
	Next     string `json:"next,omitempty" example:"https://quorum-key-manager.com/stores/your-store/secrets?page=3"`
}

type PageResponse

type PageResponse struct {
	Data   interface{}        `json:"data" example:"{'item1', 'item2', 'item3'}" swaggertype:"array,string"`
	Paging PagePagingResponse `json:"paging"`
}