meta

package
v0.0.0-...-4b49eca Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 15, 2022 License: MIT Imports: 24 Imported by: 0

README

Go API client for meta

ESI specs and miscellaneous routes

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 0.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./meta"

Documentation for API Endpoints

All URIs are relative to https://esi.evetech.net

Class Method HTTP request Description
MetaApi GetHeaders Get /headers/ Debug request headers
MetaApi GetPing Get /ping Ping route
MetaApi GetStatus Get /status.json ESI health status
MetaApi GetVerify Get /verify/ Verify access token
MetaApi GetVersions Get /versions/ List versions
SwaggerApi GetDevSwagger Get /_dev/swagger.json Get _dev spec (versioned)
SwaggerApi GetDevSwagger_0 Get /dev/swagger.json Get dev swagger spec
SwaggerApi GetLatestSwagger Get /_latest/swagger.json Get _latest spec (versioned)
SwaggerApi GetLatestSwagger_0 Get /latest/swagger.json Get latest swagger spec
SwaggerApi GetLegacySwagger Get /_legacy/swagger.json Get _legacy spec (versioned)
SwaggerApi GetLegacySwagger_0 Get /legacy/swagger.json Get legacy swagger spec
SwaggerApi GetMetaSwagger Get /swagger.json Get meta swagger spec
SwaggerApi GetV1Swagger Get /v1/swagger.json Get v1 swagger spec
SwaggerApi GetV2Swagger Get /v2/swagger.json Get v2 swagger spec
SwaggerApi GetV3Swagger Get /v3/swagger.json Get v3 swagger spec
SwaggerApi GetV4Swagger Get /v4/swagger.json Get v4 swagger spec
SwaggerApi GetV5Swagger Get /v5/swagger.json Get v5 swagger spec
SwaggerApi GetV6Swagger Get /v6/swagger.json Get v6 swagger spec
WebUIApi GetDiffVersionAVersionB Get /diff/{version_a}/{version_b}/ Diff route
WebUIApi GetUi Get /ui/ SwaggerUI route (v3)

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ContextOAuth2      = contextKey("token")
	ContextBasicAuth   = contextKey("basic")
	ContextAccessToken = contextKey("accessToken")
)

ContextOAuth2 is the context for GoESI authentication. Pass a tokenSource with this key to a context for an ESI API Call

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {

	// API Services
	MetaApi    *MetaApiService
	SwaggerApi *SwaggerApiService
	WebUIApi   *WebUIApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the ESI Meta Spec API v0.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(httpClient *http.Client, userAgent string) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetDevSwaggerOpts 

type GetDevSwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetDevSwagger_1Opts 

type GetDevSwagger_1Opts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetDiffVersionAVersionBOpts 

type GetDiffVersionAVersionBOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetLatestSwaggerOpts 

type GetLatestSwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetLatestSwagger_2Opts 

type GetLatestSwagger_2Opts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetLegacySwaggerOpts 

type GetLegacySwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetLegacySwagger_3Opts 

type GetLegacySwagger_3Opts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetMetaSwaggerOpts 

type GetMetaSwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetStatusItem 

type GetStatusItem struct {
	Endpoint string   `json:"endpoint,omitempty"` /* ESI Endpoint cluster advertising this route */
	Method   string   `json:"method,omitempty"`   /* Swagger defined method */
	Route    string   `json:"route,omitempty"`    /* Swagger defined route, not including version prefix */
	Status   string   `json:"status,omitempty"`   /* Vague route status. Green is good, yellow is degraded, meaning slow or potentially dropping requests. Red means most requests are not succeeding and/or are very slow (5s+) on average. */
	Tags     []string `json:"tags,omitempty"`     /* Swagger tags applicable to this route */
}

Per route status

func (GetStatusItem) MarshalEasyJSON 

func (v GetStatusItem) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetStatusItem) MarshalJSON 

func (v GetStatusItem) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetStatusItem) UnmarshalEasyJSON 

func (v *GetStatusItem) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetStatusItem) UnmarshalJSON 

func (v *GetStatusItem) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetStatusItemList 

type GetStatusItemList []GetStatusItem

A list of GetStatusItem.

func (GetStatusItemList) MarshalEasyJSON 

func (v GetStatusItemList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetStatusItemList) MarshalJSON 

func (v GetStatusItemList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetStatusItemList) UnmarshalEasyJSON 

func (v *GetStatusItemList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetStatusItemList) UnmarshalJSON 

func (v *GetStatusItemList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetStatusNotFound 

type GetStatusNotFound struct {
	Error_ string `json:"error,omitempty"` /* Unsupported version */
}

Unsupported version

func (GetStatusNotFound) MarshalEasyJSON 

func (v GetStatusNotFound) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetStatusNotFound) MarshalJSON 

func (v GetStatusNotFound) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetStatusNotFound) UnmarshalEasyJSON 

func (v *GetStatusNotFound) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetStatusNotFound) UnmarshalJSON 

func (v *GetStatusNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetStatusNotFoundList 

type GetStatusNotFoundList []GetStatusNotFound

A list of GetStatusNotFound.

func (GetStatusNotFoundList) MarshalEasyJSON 

func (v GetStatusNotFoundList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetStatusNotFoundList) MarshalJSON 

func (v GetStatusNotFoundList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetStatusNotFoundList) UnmarshalEasyJSON 

func (v *GetStatusNotFoundList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetStatusNotFoundList) UnmarshalJSON 

func (v *GetStatusNotFoundList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetStatusOpts 

type GetStatusOpts struct {
	Version optional.String
}

type GetUiOpts 

type GetUiOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
	Version    optional.String
}

type GetV1SwaggerOpts 

type GetV1SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetV2SwaggerOpts 

type GetV2SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetV3SwaggerOpts 

type GetV3SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetV4SwaggerOpts 

type GetV4SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetV5SwaggerOpts 

type GetV5SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetV6SwaggerOpts 

type GetV6SwaggerOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
	Datasource optional.String
}

type GetVerifyError 

type GetVerifyError struct {
	Error_           string `json:"error,omitempty"`             /* Generic error returned by SSO */
	ErrorDescription string `json:"error_description,omitempty"` /* Detailed error description from SSO */
}

SSO /verify JSON

func (GetVerifyError) MarshalEasyJSON 

func (v GetVerifyError) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyError) MarshalJSON 

func (v GetVerifyError) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyError) UnmarshalEasyJSON 

func (v *GetVerifyError) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyError) UnmarshalJSON 

func (v *GetVerifyError) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyErrorList 

type GetVerifyErrorList []GetVerifyError

A list of GetVerifyError.

func (GetVerifyErrorList) MarshalEasyJSON 

func (v GetVerifyErrorList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyErrorList) MarshalJSON 

func (v GetVerifyErrorList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyErrorList) UnmarshalEasyJSON 

func (v *GetVerifyErrorList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyErrorList) UnmarshalJSON 

func (v *GetVerifyErrorList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyNotFound 

type GetVerifyNotFound struct {
	Error_ string `json:"error,omitempty"` /* Unsupported datasource */
}

Unsupported datasource

func (GetVerifyNotFound) MarshalEasyJSON 

func (v GetVerifyNotFound) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyNotFound) MarshalJSON 

func (v GetVerifyNotFound) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyNotFound) UnmarshalEasyJSON 

func (v *GetVerifyNotFound) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyNotFound) UnmarshalJSON 

func (v *GetVerifyNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyNotFoundList 

type GetVerifyNotFoundList []GetVerifyNotFound

A list of GetVerifyNotFound.

func (GetVerifyNotFoundList) MarshalEasyJSON 

func (v GetVerifyNotFoundList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyNotFoundList) MarshalJSON 

func (v GetVerifyNotFoundList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyNotFoundList) UnmarshalEasyJSON 

func (v *GetVerifyNotFoundList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyNotFoundList) UnmarshalJSON 

func (v *GetVerifyNotFoundList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyOk 

type GetVerifyOk struct {
	CharacterID          int32  `json:"CharacterID,omitempty"`          /* Token owner's character ID */
	CharacterName        string `json:"CharacterName,omitempty"`        /* Token owner's character name */
	CharacterOwnerHash   string `json:"CharacterOwnerHash,omitempty"`   /* Hash of the character's owner. If the character is sold or otherwise transferred, this will change */
	ExpiresOn            string `json:"ExpiresOn,omitempty"`            /* Expiry time of the token (not RFC3339) */
	IntellectualProperty string `json:"IntellectualProperty,omitempty"` /* The IP which generated the token */
	Scopes               string `json:"Scopes,omitempty"`               /* Space separated list of scopes the token is valid for */
	TokenType            string `json:"TokenType,omitempty"`            /* Type of access token */
}

SSO /verify JSON

func (GetVerifyOk) MarshalEasyJSON 

func (v GetVerifyOk) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyOk) MarshalJSON 

func (v GetVerifyOk) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyOk) UnmarshalEasyJSON 

func (v *GetVerifyOk) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyOk) UnmarshalJSON 

func (v *GetVerifyOk) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyOkList 

type GetVerifyOkList []GetVerifyOk

A list of GetVerifyOk.

func (GetVerifyOkList) MarshalEasyJSON 

func (v GetVerifyOkList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyOkList) MarshalJSON 

func (v GetVerifyOkList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyOkList) UnmarshalEasyJSON 

func (v *GetVerifyOkList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyOkList) UnmarshalJSON 

func (v *GetVerifyOkList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyOpts 

type GetVerifyOpts struct {
	UserAgent     optional.String
	XUserAgent    optional.String
	Datasource    optional.String
	Token         optional.String
	Authorization optional.String
}

type GetVerifyUnauthorized 

type GetVerifyUnauthorized struct {
	Error_ string `json:"error,omitempty"` /* Authorization not provided */
}

Authorization not provided

func (GetVerifyUnauthorized) MarshalEasyJSON 

func (v GetVerifyUnauthorized) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyUnauthorized) MarshalJSON 

func (v GetVerifyUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyUnauthorized) UnmarshalEasyJSON 

func (v *GetVerifyUnauthorized) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyUnauthorized) UnmarshalJSON 

func (v *GetVerifyUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVerifyUnauthorizedList 

type GetVerifyUnauthorizedList []GetVerifyUnauthorized

A list of GetVerifyUnauthorized.

func (GetVerifyUnauthorizedList) MarshalEasyJSON 

func (v GetVerifyUnauthorizedList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVerifyUnauthorizedList) MarshalJSON 

func (v GetVerifyUnauthorizedList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVerifyUnauthorizedList) UnmarshalEasyJSON 

func (v *GetVerifyUnauthorizedList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVerifyUnauthorizedList) UnmarshalJSON 

func (v *GetVerifyUnauthorizedList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVersionsOpts 

type GetVersionsOpts struct {
	UserAgent  optional.String
	XUserAgent optional.String
}

type MetaApiService 

type MetaApiService service

func (*MetaApiService) GetHeaders 

func (a *MetaApiService) GetHeaders(ctx context.Context) (map[string]string, *http.Response, error)

MetaApiService Debug request headers Echo the request headers for debugging purposes. Note that the 'Connection' header and any 'X-' headers are not included

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]string

func (*MetaApiService) GetPing 

func (a *MetaApiService) GetPing(ctx context.Context) (string, *http.Response, error)

MetaApiService Ping route Ping the ESI routers

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*MetaApiService) GetStatus 

func (a *MetaApiService) GetStatus(ctx context.Context, localVarOptionals *GetStatusOpts) ([]GetStatusItem, *http.Response, error)

func (*MetaApiService) GetVerify 

func (a *MetaApiService) GetVerify(ctx context.Context, localVarOptionals *GetVerifyOpts) (GetVerifyOk, *http.Response, error)

func (*MetaApiService) GetVersions 

func (a *MetaApiService) GetVersions(ctx context.Context, localVarOptionals *GetVersionsOpts) ([]string, *http.Response, error)

type SwaggerApiService 

type SwaggerApiService service

func (*SwaggerApiService) GetDevSwagger 

func (a *SwaggerApiService) GetDevSwagger(ctx context.Context, localVarOptionals *GetDevSwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetDevSwagger_1 

func (a *SwaggerApiService) GetDevSwagger_1(ctx context.Context, localVarOptionals *GetDevSwagger_1Opts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetLatestSwagger 

func (a *SwaggerApiService) GetLatestSwagger(ctx context.Context, localVarOptionals *GetLatestSwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetLatestSwagger_2 

func (a *SwaggerApiService) GetLatestSwagger_2(ctx context.Context, localVarOptionals *GetLatestSwagger_2Opts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetLegacySwagger 

func (a *SwaggerApiService) GetLegacySwagger(ctx context.Context, localVarOptionals *GetLegacySwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetLegacySwagger_3 

func (a *SwaggerApiService) GetLegacySwagger_3(ctx context.Context, localVarOptionals *GetLegacySwagger_3Opts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetMetaSwagger 

func (a *SwaggerApiService) GetMetaSwagger(ctx context.Context, localVarOptionals *GetMetaSwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV1Swagger 

func (a *SwaggerApiService) GetV1Swagger(ctx context.Context, localVarOptionals *GetV1SwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV2Swagger 

func (a *SwaggerApiService) GetV2Swagger(ctx context.Context, localVarOptionals *GetV2SwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV3Swagger 

func (a *SwaggerApiService) GetV3Swagger(ctx context.Context, localVarOptionals *GetV3SwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV4Swagger 

func (a *SwaggerApiService) GetV4Swagger(ctx context.Context, localVarOptionals *GetV4SwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV5Swagger 

func (a *SwaggerApiService) GetV5Swagger(ctx context.Context, localVarOptionals *GetV5SwaggerOpts) (interface{}, *http.Response, error)

func (*SwaggerApiService) GetV6Swagger 

func (a *SwaggerApiService) GetV6Swagger(ctx context.Context, localVarOptionals *GetV6SwaggerOpts) (interface{}, *http.Response, error)

type WebUIApiService 

type WebUIApiService service

func (*WebUIApiService) GetDiffVersionAVersionB 

func (a *WebUIApiService) GetDiffVersionAVersionB(ctx context.Context, versionA string, versionB string, localVarOptionals *GetDiffVersionAVersionBOpts) (string, *http.Response, error)

func (*WebUIApiService) GetUi 

func (a *WebUIApiService) GetUi(ctx context.Context, localVarOptionals *GetUiOpts) (string, *http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.