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§

AutoAction
A change Tracker applies on a schedule to whatever matches a filter.
Automation
What changes issues in a queue without anybody touching them.
Blueprint
The parts of an existing queue a new one can be built from.
Board
A board, reduced to what a listing shows.
BulkChange
A change to many issues at once, which Tracker performs in the background.
BulkOutcome
What happened to one issue in a bulk change.
Client
A configured Tracker client.
ClientConfig
Everything the client needs to address one organisation as one account.
Component
A part of the product a queue splits its work by.
FieldOptions
What a constrained field will accept.
FieldSpec
One field’s definition: what it holds, whether it can be written, and what values it accepts.
Holder
Somebody or something that holds a right.
LinkType
One kind of relationship two issues can have.
Macro
A canned change somebody applies by hand from the issue page.
Permission
One operation, and everybody who holds it.
Queue
A queue, reduced to what a listing shows.
QueueAccess
Who may do what in a queue: the rules, and the people they come out as.
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.
Trigger
A change Tracker applies the moment something happens to an issue.
Unreadable
One section that could not be read, and why.
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.