openapi

Documentation

Index

• Constants
• func SwaggerAPIv1(writer http.ResponseWriter, _ *http.Request)
• func SwaggerUI(writer http.ResponseWriter, _ *http.Request)
• func WriteHTTPError(w http.ResponseWriter, err error)
• type HTTPError
  • func NewHTTPError(err error) *HTTPError

Constants

const JobAPIPrefix = "/api/v1/jobs/"

JobAPIPrefix is the prefix of the job API.

const JobDetailAPIFormat = JobAPIPrefix + "%s/status"

JobDetailAPIFormat is the path format for job detail status the entire path is: /api/v1/jobs/${jobID}/status

Functions

func SwaggerAPIv1

func SwaggerAPIv1(
	writer http.ResponseWriter,
	_ *http.Request,
)

SwaggerAPIv1 serves the apiv1 swagger json file.

func SwaggerUI

func SwaggerUI(
	writer http.ResponseWriter,
	_ *http.Request,
)

SwaggerUI renders the swagger ui.

func WriteHTTPError

func WriteHTTPError(w http.ResponseWriter, err error)

WriteHTTPError writes error to http response with normalized error format.

Types

type HTTPError

type HTTPError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

HTTPError is the error format for http response.

func NewHTTPError

func NewHTTPError(err error) *HTTPError

NewHTTPError creates a new HTTPError.