Skip to main content

ably_auth_openapi/apis/
configuration.rs

1/*
2 * Ably Platform Auth REST API
3 *
4 * The subset of the Ably **platform** REST API used for authentication and token lifecycle: requesting Ably Tokens, revoking them, and reading server time. This is a *separate* API from the Ably Chat REST API (`openapi/ably-chat-rest.yaml`, path prefix `/chat/v4`) — token issuance and revocation live on the platform host under `/keys/...`, not under `/chat/_*`.  ## Scope & provenance Ably publishes an authoritative platform spec, [`ably/open-specs`](https://github.com/ably/open-specs) `platform-v1.yaml`, which covers the full generic pub/sub REST API (`/channels`, `/push`, `/keys`, `/stats`, `/time`). **This document is deliberately narrow**: it models only the endpoints this project's authentication story ([ADR-0012](../docs/adr/0012-token-issuance-permissions.md), [SPEC §13](../docs/SPEC.md)) touches — `POST /keys/{keyName}/requestToken`, `POST /keys/{keyName}/revokeTokens`, and `GET /time`. Field-level details are cross-checked against `platform-v1.yaml`, the Ably auth docs, and the `ably-js` auth implementation (see [`../docs/research/2026-07-24-ably-chat-auth-permissions.md`](../docs/research/2026-07-24-ably-chat-auth-permissions.md)).  ## Relationship to the Chat client `ably-chat-rs` is a Chat REST client; it does not itself sign TokenRequests or call `/keys/...` (ADR-0012 Tier 4). This spec documents the platform endpoints a *token server* (or the official `ably` crate) uses to mint the Bearer credentials that are then handed to the Chat client. Capability documents carried by these tokens are described in SPEC §13, not here. 
5 *
6 * The version of the OpenAPI document: 1.0.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13#[derive(Debug, Clone)]
14pub struct Configuration {
15    pub base_path: String,
16    pub user_agent: Option<String>,
17    pub client: reqwest::Client,
18    pub basic_auth: Option<BasicAuth>,
19    pub oauth_access_token: Option<String>,
20    pub bearer_access_token: Option<String>,
21    pub api_key: Option<ApiKey>,
22}
23
24pub type BasicAuth = (String, Option<String>);
25
26#[derive(Debug, Clone)]
27pub struct ApiKey {
28    pub prefix: Option<String>,
29    pub key: String,
30}
31
32
33impl Configuration {
34    pub fn new() -> Configuration {
35        Configuration::default()
36    }
37}
38
39impl Default for Configuration {
40    fn default() -> Self {
41        Configuration {
42            base_path: "https://rest.ably.io".to_owned(),
43            user_agent: Some("OpenAPI-Generator/1.0.0/rust".to_owned()),
44            client: reqwest::Client::new(),
45            basic_auth: None,
46            oauth_access_token: None,
47            bearer_access_token: None,
48            api_key: None,
49        }
50    }
51}