Documentation
¶
Overview ¶
Package smithsonian is the library behind the smithsonian command line: the HTTP client, request shaping, and typed data models for the Smithsonian Open Access API (https://api.si.edu/openaccess/api/v1.0).
The demo API key (DEMO_KEY) works without registration. The Client paces requests, sets a real User-Agent, and retries transient failures (429 and 5xx).
Index ¶
Constants ¶
const Host = "api.si.edu"
Host is the API hostname.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to the Smithsonian Open Access API.
type Config ¶
type Config struct {
BaseURL string
APIKey string
UserAgent string
Rate time.Duration
Timeout time.Duration
Retries int
}
Config holds all tunable parameters for the Client.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults.
type Domain ¶
type Domain struct{}
Domain is the smithsonian driver.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, hostnames, and binary identity.
type Object ¶
type Object struct {
ID string `kit:"id" json:"id"`
Title string `json:"title"`
UnitCode string `json:"unit_code"`
DataSource string `json:"data_source"`
Type string `json:"type"`
RecordLink string `json:"record_link,omitempty"`
Access string `json:"access,omitempty"`
}
Object holds the public data about a single Smithsonian museum object.