// Package api provides primitives to interact the openapi HTTP API. // // Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT. package api import ( "bytes" "context" "encoding/json" "fmt" "github.com/deepmap/oapi-codegen/pkg/runtime" "github.com/labstack/echo/v4" "io" "io/ioutil" "net/http" "net/url" "strings" ) // RequestJobJSONBody defines parameters for RequestJob. type RequestJobJSONBody map[string]interface{} // UpdateJobJSONBody defines parameters for UpdateJob. type UpdateJobJSONBody struct { Result interface{} `json:"result"` Status string `json:"status"` } // RequestJobRequestBody defines body for RequestJob for application/json ContentType. type RequestJobJSONRequestBody RequestJobJSONBody // UpdateJobRequestBody defines body for UpdateJob for application/json ContentType. type UpdateJobJSONRequestBody UpdateJobJSONBody // RequestEditorFn is the function signature for the RequestEditor callback function type RequestEditorFn func(ctx context.Context, req *http.Request) error // Doer performs HTTP requests. // // The standard http.Client implements this interface. type HttpRequestDoer interface { Do(req *http.Request) (*http.Response, error) } // Client which conforms to the OpenAPI3 specification for this service. type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A callback for modifying requests which are generated before sending over // the network. RequestEditor RequestEditorFn } // ClientOption allows setting custom parameters during construction type ClientOption func(*Client) error // Creates a new Client, with reasonable defaults func NewClient(server string, opts ...ClientOption) (*Client, error) { // create a client with sane default values client := Client{ Server: server, } // mutate client and add all optional params for _, o := range opts { if err := o(&client); err != nil { return nil, err } } // ensure the server URL always has a trailing slash if !strings.HasSuffix(client.Server, "/") { client.Server += "/" } // create httpClient, if not already present if client.Client == nil { client.Client = http.DefaultClient } return &client, nil } // WithHTTPClient allows overriding the default Doer, which is // automatically created using http.Client. This is useful for tests. func WithHTTPClient(doer HttpRequestDoer) ClientOption { return func(c *Client) error { c.Client = doer return nil } } // WithRequestEditorFn allows setting up a callback function, which will be // called right before sending the request. This can be used to mutate the request. func WithRequestEditorFn(fn RequestEditorFn) ClientOption { return func(c *Client) error { c.RequestEditor = fn return nil } } // The interface specification for the client above. type ClientInterface interface { // RequestJob request with any body RequestJobWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error) RequestJob(ctx context.Context, body RequestJobJSONRequestBody) (*http.Response, error) // GetJob request GetJob(ctx context.Context, token string) (*http.Response, error) // UpdateJob request with any body UpdateJobWithBody(ctx context.Context, token string, contentType string, body io.Reader) (*http.Response, error) UpdateJob(ctx context.Context, token string, body UpdateJobJSONRequestBody) (*http.Response, error) // UploadJobArtifact request with any body UploadJobArtifactWithBody(ctx context.Context, token string, name string, contentType string, body io.Reader) (*http.Response, error) // GetStatus request GetStatus(ctx context.Context) (*http.Response, error) } func (c *Client) RequestJobWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error) { req, err := NewRequestJobRequestWithBody(c.Server, contentType, body) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) RequestJob(ctx context.Context, body RequestJobJSONRequestBody) (*http.Response, error) { req, err := NewRequestJobRequest(c.Server, body) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) GetJob(ctx context.Context, token string) (*http.Response, error) { req, err := NewGetJobRequest(c.Server, token) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) UpdateJobWithBody(ctx context.Context, token string, contentType string, body io.Reader) (*http.Response, error) { req, err := NewUpdateJobRequestWithBody(c.Server, token, contentType, body) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) UpdateJob(ctx context.Context, token string, body UpdateJobJSONRequestBody) (*http.Response, error) { req, err := NewUpdateJobRequest(c.Server, token, body) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) UploadJobArtifactWithBody(ctx context.Context, token string, name string, contentType string, body io.Reader) (*http.Response, error) { req, err := NewUploadJobArtifactRequestWithBody(c.Server, token, name, contentType, body) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } func (c *Client) GetStatus(ctx context.Context) (*http.Response, error) { req, err := NewGetStatusRequest(c.Server) if err != nil { return nil, err } req = req.WithContext(ctx) if c.RequestEditor != nil { err = c.RequestEditor(ctx, req) if err != nil { return nil, err } } return c.Client.Do(req) } // NewRequestJobRequest calls the generic RequestJob builder with application/json body func NewRequestJobRequest(server string, body RequestJobJSONRequestBody) (*http.Request, error) { var bodyReader io.Reader buf, err := json.Marshal(body) if err != nil { return nil, err } bodyReader = bytes.NewReader(buf) return NewRequestJobRequestWithBody(server, "application/json", bodyReader) } // NewRequestJobRequestWithBody generates requests for RequestJob with any type of body func NewRequestJobRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error) { var err error queryUrl, err := url.Parse(server) if err != nil { return nil, err } basePath := fmt.Sprintf("/jobs") if basePath[0] == '/' { basePath = basePath[1:] } queryUrl, err = queryUrl.Parse(basePath) if err != nil { return nil, err } req, err := http.NewRequest("POST", queryUrl.String(), body) if err != nil { return nil, err } req.Header.Add("Content-Type", contentType) return req, nil } // NewGetJobRequest generates requests for GetJob func NewGetJobRequest(server string, token string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParam("simple", false, "token", token) if err != nil { return nil, err } queryUrl, err := url.Parse(server) if err != nil { return nil, err } basePath := fmt.Sprintf("/jobs/%s", pathParam0) if basePath[0] == '/' { basePath = basePath[1:] } queryUrl, err = queryUrl.Parse(basePath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryUrl.String(), nil) if err != nil { return nil, err } return req, nil } // NewUpdateJobRequest calls the generic UpdateJob builder with application/json body func NewUpdateJobRequest(server string, token string, body UpdateJobJSONRequestBody) (*http.Request, error) { var bodyReader io.Reader buf, err := json.Marshal(body) if err != nil { return nil, err } bodyReader = bytes.NewReader(buf) return NewUpdateJobRequestWithBody(server, token, "application/json", bodyReader) } // NewUpdateJobRequestWithBody generates requests for UpdateJob with any type of body func NewUpdateJobRequestWithBody(server string, token string, contentType string, body io.Reader) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParam("simple", false, "token", token) if err != nil { return nil, err } queryUrl, err := url.Parse(server) if err != nil { return nil, err } basePath := fmt.Sprintf("/jobs/%s", pathParam0) if basePath[0] == '/' { basePath = basePath[1:] } queryUrl, err = queryUrl.Parse(basePath) if err != nil { return nil, err } req, err := http.NewRequest("PATCH", queryUrl.String(), body) if err != nil { return nil, err } req.Header.Add("Content-Type", contentType) return req, nil } // NewUploadJobArtifactRequestWithBody generates requests for UploadJobArtifact with any type of body func NewUploadJobArtifactRequestWithBody(server string, token string, name string, contentType string, body io.Reader) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParam("simple", false, "token", token) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParam("simple", false, "name", name) if err != nil { return nil, err } queryUrl, err := url.Parse(server) if err != nil { return nil, err } basePath := fmt.Sprintf("/jobs/%s/artifacts/%s", pathParam0, pathParam1) if basePath[0] == '/' { basePath = basePath[1:] } queryUrl, err = queryUrl.Parse(basePath) if err != nil { return nil, err } req, err := http.NewRequest("PUT", queryUrl.String(), body) if err != nil { return nil, err } req.Header.Add("Content-Type", contentType) return req, nil } // NewGetStatusRequest generates requests for GetStatus func NewGetStatusRequest(server string) (*http.Request, error) { var err error queryUrl, err := url.Parse(server) if err != nil { return nil, err } basePath := fmt.Sprintf("/status") if basePath[0] == '/' { basePath = basePath[1:] } queryUrl, err = queryUrl.Parse(basePath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryUrl.String(), nil) if err != nil { return nil, err } return req, nil } // ClientWithResponses builds on ClientInterface to offer response payloads type ClientWithResponses struct { ClientInterface } // NewClientWithResponses creates a new ClientWithResponses, which wraps // Client with return type handling func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { client, err := NewClient(server, opts...) if err != nil { return nil, err } return &ClientWithResponses{client}, nil } // WithBaseURL overrides the baseURL. func WithBaseURL(baseURL string) ClientOption { return func(c *Client) error { newBaseURL, err := url.Parse(baseURL) if err != nil { return err } c.Server = newBaseURL.String() return nil } } // ClientWithResponsesInterface is the interface specification for the client with responses above. type ClientWithResponsesInterface interface { // RequestJob request with any body RequestJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*RequestJobResponse, error) RequestJobWithResponse(ctx context.Context, body RequestJobJSONRequestBody) (*RequestJobResponse, error) // GetJob request GetJobWithResponse(ctx context.Context, token string) (*GetJobResponse, error) // UpdateJob request with any body UpdateJobWithBodyWithResponse(ctx context.Context, token string, contentType string, body io.Reader) (*UpdateJobResponse, error) UpdateJobWithResponse(ctx context.Context, token string, body UpdateJobJSONRequestBody) (*UpdateJobResponse, error) // UploadJobArtifact request with any body UploadJobArtifactWithBodyWithResponse(ctx context.Context, token string, name string, contentType string, body io.Reader) (*UploadJobArtifactResponse, error) // GetStatus request GetStatusWithResponse(ctx context.Context) (*GetStatusResponse, error) } type RequestJobResponse struct { Body []byte HTTPResponse *http.Response JSON201 *struct { Manifest interface{} `json:"manifest"` Targets *[]interface{} `json:"targets,omitempty"` Token string `json:"token"` } } // Status returns HTTPResponse.Status func (r RequestJobResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r RequestJobResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetJobResponse struct { Body []byte HTTPResponse *http.Response JSON200 *struct { Canceled bool `json:"canceled"` } } // Status returns HTTPResponse.Status func (r GetJobResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetJobResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UpdateJobResponse struct { Body []byte HTTPResponse *http.Response } // Status returns HTTPResponse.Status func (r UpdateJobResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UpdateJobResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UploadJobArtifactResponse struct { Body []byte HTTPResponse *http.Response } // Status returns HTTPResponse.Status func (r UploadJobArtifactResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UploadJobArtifactResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetStatusResponse struct { Body []byte HTTPResponse *http.Response JSON200 *struct { Status string `json:"status"` } } // Status returns HTTPResponse.Status func (r GetStatusResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetStatusResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } // RequestJobWithBodyWithResponse request with arbitrary body returning *RequestJobResponse func (c *ClientWithResponses) RequestJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*RequestJobResponse, error) { rsp, err := c.RequestJobWithBody(ctx, contentType, body) if err != nil { return nil, err } return ParseRequestJobResponse(rsp) } func (c *ClientWithResponses) RequestJobWithResponse(ctx context.Context, body RequestJobJSONRequestBody) (*RequestJobResponse, error) { rsp, err := c.RequestJob(ctx, body) if err != nil { return nil, err } return ParseRequestJobResponse(rsp) } // GetJobWithResponse request returning *GetJobResponse func (c *ClientWithResponses) GetJobWithResponse(ctx context.Context, token string) (*GetJobResponse, error) { rsp, err := c.GetJob(ctx, token) if err != nil { return nil, err } return ParseGetJobResponse(rsp) } // UpdateJobWithBodyWithResponse request with arbitrary body returning *UpdateJobResponse func (c *ClientWithResponses) UpdateJobWithBodyWithResponse(ctx context.Context, token string, contentType string, body io.Reader) (*UpdateJobResponse, error) { rsp, err := c.UpdateJobWithBody(ctx, token, contentType, body) if err != nil { return nil, err } return ParseUpdateJobResponse(rsp) } func (c *ClientWithResponses) UpdateJobWithResponse(ctx context.Context, token string, body UpdateJobJSONRequestBody) (*UpdateJobResponse, error) { rsp, err := c.UpdateJob(ctx, token, body) if err != nil { return nil, err } return ParseUpdateJobResponse(rsp) } // UploadJobArtifactWithBodyWithResponse request with arbitrary body returning *UploadJobArtifactResponse func (c *ClientWithResponses) UploadJobArtifactWithBodyWithResponse(ctx context.Context, token string, name string, contentType string, body io.Reader) (*UploadJobArtifactResponse, error) { rsp, err := c.UploadJobArtifactWithBody(ctx, token, name, contentType, body) if err != nil { return nil, err } return ParseUploadJobArtifactResponse(rsp) } // GetStatusWithResponse request returning *GetStatusResponse func (c *ClientWithResponses) GetStatusWithResponse(ctx context.Context) (*GetStatusResponse, error) { rsp, err := c.GetStatus(ctx) if err != nil { return nil, err } return ParseGetStatusResponse(rsp) } // ParseRequestJobResponse parses an HTTP response from a RequestJobWithResponse call func ParseRequestJobResponse(rsp *http.Response) (*RequestJobResponse, error) { bodyBytes, err := ioutil.ReadAll(rsp.Body) defer rsp.Body.Close() if err != nil { return nil, err } response := &RequestJobResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 201: var dest struct { Manifest interface{} `json:"manifest"` Targets *[]interface{} `json:"targets,omitempty"` Token string `json:"token"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON201 = &dest } return response, nil } // ParseGetJobResponse parses an HTTP response from a GetJobWithResponse call func ParseGetJobResponse(rsp *http.Response) (*GetJobResponse, error) { bodyBytes, err := ioutil.ReadAll(rsp.Body) defer rsp.Body.Close() if err != nil { return nil, err } response := &GetJobResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest struct { Canceled bool `json:"canceled"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseUpdateJobResponse parses an HTTP response from a UpdateJobWithResponse call func ParseUpdateJobResponse(rsp *http.Response) (*UpdateJobResponse, error) { bodyBytes, err := ioutil.ReadAll(rsp.Body) defer rsp.Body.Close() if err != nil { return nil, err } response := &UpdateJobResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { } return response, nil } // ParseUploadJobArtifactResponse parses an HTTP response from a UploadJobArtifactWithResponse call func ParseUploadJobArtifactResponse(rsp *http.Response) (*UploadJobArtifactResponse, error) { bodyBytes, err := ioutil.ReadAll(rsp.Body) defer rsp.Body.Close() if err != nil { return nil, err } response := &UploadJobArtifactResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { } return response, nil } // ParseGetStatusResponse parses an HTTP response from a GetStatusWithResponse call func ParseGetStatusResponse(rsp *http.Response) (*GetStatusResponse, error) { bodyBytes, err := ioutil.ReadAll(rsp.Body) defer rsp.Body.Close() if err != nil { return nil, err } response := &GetStatusResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest struct { Status string `json:"status"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ServerInterface represents all server handlers. type ServerInterface interface { // Request a job // (POST /jobs) RequestJob(ctx echo.Context) error // Get running job // (GET /jobs/{token}) GetJob(ctx echo.Context, token string) error // Update a running job // (PATCH /jobs/{token}) UpdateJob(ctx echo.Context, token string) error // Upload an artifact // (PUT /jobs/{token}/artifacts/{name}) UploadJobArtifact(ctx echo.Context, token string, name string) error // status // (GET /status) GetStatus(ctx echo.Context) error } // ServerInterfaceWrapper converts echo contexts to parameters. type ServerInterfaceWrapper struct { Handler ServerInterface } // RequestJob converts echo context to params. func (w *ServerInterfaceWrapper) RequestJob(ctx echo.Context) error { var err error // Invoke the callback with all the unmarshalled arguments err = w.Handler.RequestJob(ctx) return err } // GetJob converts echo context to params. func (w *ServerInterfaceWrapper) GetJob(ctx echo.Context) error { var err error // ------------- Path parameter "token" ------------- var token string err = runtime.BindStyledParameter("simple", false, "token", ctx.Param("token"), &token) if err != nil { return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter token: %s", err)) } // Invoke the callback with all the unmarshalled arguments err = w.Handler.GetJob(ctx, token) return err } // UpdateJob converts echo context to params. func (w *ServerInterfaceWrapper) UpdateJob(ctx echo.Context) error { var err error // ------------- Path parameter "token" ------------- var token string err = runtime.BindStyledParameter("simple", false, "token", ctx.Param("token"), &token) if err != nil { return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter token: %s", err)) } // Invoke the callback with all the unmarshalled arguments err = w.Handler.UpdateJob(ctx, token) return err } // UploadJobArtifact converts echo context to params. func (w *ServerInterfaceWrapper) UploadJobArtifact(ctx echo.Context) error { var err error // ------------- Path parameter "token" ------------- var token string err = runtime.BindStyledParameter("simple", false, "token", ctx.Param("token"), &token) if err != nil { return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter token: %s", err)) } // ------------- Path parameter "name" ------------- var name string err = runtime.BindStyledParameter("simple", false, "name", ctx.Param("name"), &name) if err != nil { return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter name: %s", err)) } // Invoke the callback with all the unmarshalled arguments err = w.Handler.UploadJobArtifact(ctx, token, name) return err } // GetStatus converts echo context to params. func (w *ServerInterfaceWrapper) GetStatus(ctx echo.Context) error { var err error // Invoke the callback with all the unmarshalled arguments err = w.Handler.GetStatus(ctx) return err } // This is a simple interface which specifies echo.Route addition functions which // are present on both echo.Echo and echo.Group, since we want to allow using // either of them for path registration type EchoRouter interface { CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route } // RegisterHandlers adds each server route to the EchoRouter. func RegisterHandlers(router EchoRouter, si ServerInterface) { wrapper := ServerInterfaceWrapper{ Handler: si, } router.POST("/jobs", wrapper.RequestJob) router.GET("/jobs/:token", wrapper.GetJob) router.PATCH("/jobs/:token", wrapper.UpdateJob) router.PUT("/jobs/:token/artifacts/:name", wrapper.UploadJobArtifact) router.GET("/status", wrapper.GetStatus) }