openapp-sdk-common 0.1.53

Shared models and low-level types for the OpenApp SDK (single contract: packages/api-spec/openapi.json).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Shared models and types for the `OpenApp` SDK.
//!
//! This crate holds:
//!
//! * a small set of hand-written envelopes that every language SDK needs (auth token parsing,
//!   the wire-level [`ApiErrorResponse`]), and
//! * a committed [`generated`] module which mirrors the strongly-typed models produced from
//!   `packages/api-spec/openapi.json` via [`progenitor`](https://github.com/oxidecomputer/progenitor).
//!
//! The `generated` module is regenerated on demand with
//!
//! ```text
//! just sdk::core::openapi-gen
//! ```
//!
//! (drift-checked by `just sdk::core::openapi-check`). Default builds do **not** invoke the
//! generator; the committed file is authoritative and compiled as-is.

#![deny(rust_2018_idioms, missing_debug_implementations)]
#![warn(clippy::pedantic)]
#![allow(clippy::module_name_repetitions)]

pub mod error;
pub mod token;

pub mod generated;

pub use error::ApiErrorResponse;
pub use token::{API_KEY_SEPARATOR, ApiKey, TokenFormatError};

/// The SDK name we advertise in the `User-Agent` header.
pub const SDK_NAME: &str = "openapp-sdk";

/// The SDK version (kept in sync with `Cargo.toml`).
pub const SDK_VERSION: &str = env!("CARGO_PKG_VERSION");