Module seaplane_cli::api

source ·
Expand description

Wrapping seaplane SDK calls with things like CLI specific contexts, errors, etc.

Structs

FormationsReq
Wraps an SDK FormationsRequest where we do additional things like re-use request access tokens, allow changing the Formation this request is pointed to, and map errors appropriately.
LocksReq
Wraps an SDK LocksRequest where we do additional things like re-use request access tokens, allow changing the Locks this request is pointed to, and map errors appropriately.
MetadataReq
Wraps an SDK MetadataRequest where we do additional things like re-use request access tokens, allow changing the Formation this request is pointed to, and map errors appropriately.
RestrictReq
Wraps an SDK RestrictRequest where we do additional things like re-use request access tokens, and map errors appropriately.

Functions

request_token
Makes a request against the /token endpoint of FlightDeck using the discovered API key and returns the short lived Access token response.
request_token_jwt
Follows the same process as request_token but only returns the raw JWT string part of the token