Documentation
¶
Overview ¶
Package api is the HTTP API: one folder per route, each calling the same processes as the CLI.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package readsearch is the API route running a saved search.
|
Package readsearch is the API route running a saved search. |
|
services
|
|
|
auth
Package auth lets through the requests of a logged-in account only, and tells the routes which one.
|
Package auth lets through the requests of a logged-in account only, and tells the routes which one. |
|
compress
Package compress sends the big JSON answers of the API as gzip: on Tailscale from a phone, weight costs more than the server's time.
|
Package compress sends the big JSON answers of the API as gzip: on Tailscale from a phone, weight costs more than the server's time. |
|
guard
Package guard keeps the web pages of other sites away from the API: they could use the session cookie.
|
Package guard keeps the web pages of other sites away from the API: they could use the session cookie. |
|
plan
Package plan refuses the routes of a paid feature to the accounts whose plan lacks it.
|
Package plan refuses the routes of a paid feature to the accounts whose plan lacks it. |
|
respond
Package respond is what every route shares: reading the request, writing JSON, turning process errors into statuses.
|
Package respond is what every route shares: reading the request, writing JSON, turning process errors into statuses. |
|
throttle
Package throttle makes a key wait longer after each try in a row: wrong passwords at the login, accounts created from one address at the sign-up.
|
Package throttle makes a key wait longer after each try in a row: wrong passwords at the login, accounts created from one address at the sign-up. |
|
Package users is the account routes an admin uses, and the self-service sign-up: the rest of an account's own routes are in login/.
|
Package users is the account routes an admin uses, and the self-service sign-up: the rest of an account's own routes are in login/. |
Click to show internal directories.
Click to hide internal directories.