client

package

v1.0.0 Latest Latest Go to latest Published: Apr 25, 2022 License: GPL-3.0 Imports: 8 Imported by: 0

Details

View Source

const (
	CapabilityFeedMETARs uint = 1 << 1
)

This section is empty.

This section is empty.

type APIError struct {
	Type    string         `json:"type"`
	Message string         `json:"message"`
	Details map[string]any `json:"details"`
}

APIError represents a single error present in an APIErrorResponse

type APIErrorResponse struct {
	Status int         `json:"status"`
	Errors []*APIError `json:"errors"`
}

APIErrorResponse represents an error response following the error structure of the data server

func (resp *APIErrorResponse) Error() string

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

Client represents the data API client to use for feeding

func New(address, key string) *Client

New creates a new data API client

func (client *Client) FeedMETARs(metars []string) ([]int, error)

FeedMETARs feeds METARs into the data server

func (client *Client) FeedMETARsRelaxed(metars []string) error

FeedMETARsRelaxed works the same as FeedMETARs with the exception that it simply skips METARs with an invalid format

func (client *Client) GetKeyInfo() (*KeyInfo, error)

GetKeyInfo retrieves the KeyInfo about the currently used API key

type KeyInfo struct {
	Quota        int64 `json:"quota"`
	RateLimit    int   `json:"rate_limit"`
	Capabilities uint  `json:"capabilities"`
}

KeyInfo represents the important information of a data API key