jinxapi_github/lib.rs
1//! Clients for GitHub API.
2//!
3//! Generated from <https://github.com/github/rest-api-description/commits/main/descriptions/api.github.com/api.github.com.json>
4//! SHA 6985b0b dated 27 April 2022
5//!
6//! # HTTP library support
7//!
8//! The underlying web library can be selected as a feature.
9//!
10//! For `hyper`, the feature `hyper-client` is enabled by default.
11//!
12//! For async `reqwest` use
13//! ```text
14//! [dependencies]
15//! jinxapi-github = { version = "0.1", default-features = false, features = ["reqwest-async"] }
16//! ```
17//!
18//! For blocking `reqwest` use
19//! ```text
20//! [dependencies]
21//! jinxapi-github = { version = "0.1", default-features = false, features = ["reqwest-blocking"] }
22//! ```
23//!
24//! # Using the API
25//!
26//! Broadly, the steps to use the API are:
27//! - Create a [`v1_1_4::config::Configuration`] object, including authentication credentials.
28//! - Create a client for the underlying HTTP library (`hyper` or `reqwest`).
29//! - Create a `Caller` ([`v1_1_4::hyper::Caller`], [`v1_1_4::reqwest::Caller`], [`v1_1_4::reqwest::blocking::Caller`]), providing the `Configuration`, Client, and an appropriate function
30//! for sleeping (e.g. `std::thread::sleep` or `tokio::time::sleep`).
31//! - For requests with a body, create the body type.
32//! - Call a method on the `Caller`, passing in operation parameters and, if required, a body.
33//! - Handle the response returned from the method.
34//!
35//! See the [test](https://github.com/jinxapi/github-rs/tree/main/tests) and [example](https://github.com/jinxapi/github-rs/tree/main/examples) code for examples of these steps.
36
37
38
39pub mod types;
40
41pub mod v1_1_4;