49 lines
2.2 KiB
Go
49 lines
2.2 KiB
Go
/*
|
|
SpaceTraders API
|
|
|
|
SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe. The API is documented using [OpenAPI](https://github.com/SpaceTradersAPI/api-docs). You can send your first request right here in your browser to check the status of the game server. ```json http { \"method\": \"GET\", \"url\": \"https://api.spacetraders.io/v2\", } ``` Unlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community. We have a [Discord channel](https://discord.com/invite/jh6zurdWk5) where you can share your projects, ask questions, and get help from other players.
|
|
|
|
API version: 2.0.0
|
|
Contact: joel@spacetraders.io
|
|
*/
|
|
|
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
|
|
|
|
package spacetraders
|
|
|
|
import (
|
|
"net/http"
|
|
)
|
|
|
|
// APIResponse stores the API response returned by the server.
|
|
type APIResponse struct {
|
|
*http.Response `json:"-"`
|
|
Message string `json:"message,omitempty"`
|
|
// Operation is the name of the OpenAPI operation.
|
|
Operation string `json:"operation,omitempty"`
|
|
// RequestURL is the request URL. This value is always available, even if the
|
|
// embedded *http.Response is nil.
|
|
RequestURL string `json:"url,omitempty"`
|
|
// Method is the HTTP method used for the request. This value is always
|
|
// available, even if the embedded *http.Response is nil.
|
|
Method string `json:"method,omitempty"`
|
|
// Payload holds the contents of the response body (which may be nil or empty).
|
|
// This is provided here as the raw response.Body() reader will have already
|
|
// been drained.
|
|
Payload []byte `json:"-"`
|
|
}
|
|
|
|
// NewAPIResponse returns a new APIResponse object.
|
|
func NewAPIResponse(r *http.Response) *APIResponse {
|
|
|
|
response := &APIResponse{Response: r}
|
|
return response
|
|
}
|
|
|
|
// NewAPIResponseWithError returns a new APIResponse object with the provided error message.
|
|
func NewAPIResponseWithError(errorMessage string) *APIResponse {
|
|
|
|
response := &APIResponse{Message: errorMessage}
|
|
return response
|
|
}
|