bezant_api/lib.rs
1//! # bezant-api
2//!
3//! Auto-generated Rust client for the
4//! [IBKR Client Portal Web API][cpapi]. Generated from the OpenAPI 3.1 spec
5//! vendored in [`bezant-spec`] via [`oas3-gen`].
6//!
7//! You can consume this crate directly for raw, 1:1 access to every endpoint
8//! and type. For a smaller, ergonomic facade — keepalive tasks, pagination
9//! helpers, symbol caching — use the [`bezant`] crate on top.
10//!
11//! ## Regeneration
12//!
13//! Regenerate with `./scripts/codegen.sh` — it upgrades the vendored 3.0 spec
14//! to 3.1, then runs `oas3-gen client-mod`.
15//!
16//! [cpapi]: https://www.interactivebrokers.com/campus/ibkr-api-page/cpapi-v1/
17//! [`bezant-spec`]: https://docs.rs/bezant-spec
18//! [`bezant`]: https://docs.rs/bezant
19//! [`oas3-gen`]: https://github.com/eklipse2k8/oas3-gen
20
21// Generated code — we don't hold it to our hand-written clippy standards.
22// Every crate that consumes `bezant-api` has these allows applied transitively
23// to silence the noise.
24#![allow(dead_code)]
25#![allow(missing_docs)]
26#![allow(clippy::all)]
27#![allow(clippy::pedantic)]
28#![allow(clippy::nursery)]
29#![allow(clippy::cargo)]
30#![allow(non_camel_case_types)]
31#![allow(non_snake_case)]
32#![allow(unused_imports)]
33#![allow(unused_variables)]
34// Generated docstrings frequently include `[1]` / `[0]` literals that
35// rustdoc tries to parse as intra-doc links, plus bare URLs that
36// aren't formal hyperlinks. Suppress the warnings rather than
37// mass-edit the generator output.
38#![allow(rustdoc::broken_intra_doc_links)]
39#![allow(rustdoc::bare_urls)]
40
41pub mod generated;
42
43pub use generated::*;