Skip to main content

Module api

Module api 

Source
Expand description

HTTP layer against the Tracker REST API.

We talk to the API directly instead of using the official Python-era client: see docs/adr/0004-own-http-client.md.

Modules§

duration
Durations, in the two forms this tool has to speak.
error
Typed API failures.
models
Normalised entities.
parse
Turning Tracker’s payloads into our models.
query
Building Tracker query strings from filter flags.

Structs§

Blueprint
The parts of an existing queue a new one can be built from.
Board
A board, reduced to what a listing shows.
Client
A configured Tracker client.
ClientConfig
Everything the client needs to address one organisation as one account.
Queue
A queue, reduced to what a listing shows.
QueueField
One field of a queue. queue fields is how a caller learns the keys that --fields and --set accept, so the key matters more than the name here.
QueueSettings
A queue with the settings that decide what an issue in it starts as.
Sprint
One sprint of a board.
Template
One template, reduced to what a listing shows.
Transition
A workflow transition available from the current status.
Version
A release a queue tracks work against.

Enums§

Dictionary
Which organisation-wide dictionary to read.
TemplateKind
Which templates are being asked for.

Constants§

DEFAULT_BASE_URL
Default API root. Overridable so tests can point at a wiremock server.