getapidoc

Documentation

Index

• Constants
• Variables
• type GetAPIDocRequest
• type GetAPIDocResponse
  • func GetAPIDoc(_ GetAPIDocRequest) (GetAPIDocResponse, *errors.ODSError)

Constants

const (
	DocAPIFile = "./doc/api/index.html"
)

Variables

var GetAPIDocMeta = endpointdef.New(
	"getAPIDoc",
	"/doc/api",
	http.MethodGet,
	http.StatusOK,
)

GetAPIDocMeta holds the endpoint information

Types

type GetAPIDocRequest

type GetAPIDocRequest struct{}

GetAPIDocRequest is the request structure

type GetAPIDocResponse

type GetAPIDocResponse []byte

GetAPIDocResponse holds the response structure

func GetAPIDoc

func GetAPIDoc(_ GetAPIDocRequest) (GetAPIDocResponse, *errors.ODSError)

GetAPIDoc returns the documentation on the API