github.com/spinnaker/spin@v1.30.0/gateapi/response.go (about)

     1  /*
     2   * Spinnaker API
     3   *
     4   * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
     5   *
     6   * API version: 1.0.0
     7   * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
     8   */
     9  
    10  package swagger
    11  
    12  import (
    13  	"net/http"
    14  )
    15  
    16  type APIResponse struct {
    17  	*http.Response `json:"-"`
    18  	Message        string `json:"message,omitempty"`
    19  	// Operation is the name of the swagger operation.
    20  	Operation string `json:"operation,omitempty"`
    21  	// RequestURL is the request URL. This value is always available, even if the
    22  	// embedded *http.Response is nil.
    23  	RequestURL string `json:"url,omitempty"`
    24  	// Method is the HTTP method used for the request.  This value is always
    25  	// available, even if the embedded *http.Response is nil.
    26  	Method string `json:"method,omitempty"`
    27  	// Payload holds the contents of the response body (which may be nil or empty).
    28  	// This is provided here as the raw response.Body() reader will have already
    29  	// been drained.
    30  	Payload []byte `json:"-"`
    31  }
    32  
    33  func NewAPIResponse(r *http.Response) *APIResponse {
    34  
    35  	response := &APIResponse{Response: r}
    36  	return response
    37  }
    38  
    39  func NewAPIResponseWithError(errorMessage string) *APIResponse {
    40  
    41  	response := &APIResponse{Message: errorMessage}
    42  	return response
    43  }