roctogen 0.50.0

Github API and models generated from the official swagger OpenAPI specification
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

//! [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
//! [![docs](https://docs.rs/roctogen/badge.svg)](https://docs.rs/roctogen/)
//! [![GitHub workflow](https://github.com/fussybeaver/roctogen/actions/workflows/default.yml/badge.svg)](https://github.com/fussybeaver/roctogen/actions/workflows/default.yml)
//!
//! # Roctogen: Rust Client Library for GitHub v3 API  
//!
//! **Roctogen** is a Rust library generated from the [GitHub REST API OpenAPI
//! specification](https://github.com/github/rest-api-description/). providing
//! comprehensive support for the GitHub v3 API. It offers flexible support for
//! both synchronous and asynchronous HTTP clients, including WebAssembly
//! compatibility. You can choose between multiple client libraries via Cargo
//! features, or integrate your own HTTP client handling by extending the
//! `adapter` subsytem:
//!
//!   - `reqwest`: Enables asynchronous requests using the [Reqwest client](https://github.com/seanmonstar/reqwest)
//!   - `ureq`: Provides synchronous requests with the [Ureq client](https://github.com/algesten/ureq) 
//!
//! ## Installation
//!
//! To include Roctogen in your project, add it to your `Cargo.toml`:
//!
//! ```nocompile
//! [dependencies]
//! roctogen = "*"
//! roctokit = "*"
//! ```
//!
//! ## Documentation
//!
//! - [API docs](https://docs.rs/roctogen/latest).
//! - [Endpoints](https://docs.rs/roctogen/latest/roctogen/endpoints/index.html).
//!
//! ### Supported endpoints:
//! 
//! Roctogen supports a wide range of GitHub API endpoints, including:
//! 
//!   - [Meta](https://docs.rs/roctogen/latest/roctogen/endpoints/meta/struct.Meta.html)
//!   - [Issues](https://docs.rs/roctogen/latest/roctogen/endpoints/issues/struct.Issues.html)
//!   - [Licenses](https://docs.rs/roctogen/latest/roctogen/endpoints/licenses/struct.Licenses.html)
//!   - [Reactions](https://docs.rs/roctogen/latest/roctogen/endpoints/reactions/struct.Reactions.html)
//!   - [Activity](https://docs.rs/roctogen/latest/roctogen/endpoints/activity/struct.Activity.html)
//!   - [Orgs](https://docs.rs/roctogen/latest/roctogen/endpoints/orgs/struct.Orgs.html)
//!   - [Users](https://docs.rs/roctogen/latest/roctogen/endpoints/users/struct.Users.html)
//!   - [Apps](https://docs.rs/roctogen/latest/roctogen/endpoints/apps/struct.Apps.html)
//!   - [ProjectsClassic](https://docs.rs/roctogen/latest/roctogen/endpoints/projects_classic/struct.ProjectsClassic.html)
//!   - [RateLimit](https://docs.rs/roctogen/latest/roctogen/endpoints/rate_limit/struct.RateLimit.html)
//!   - [Repos](https://docs.rs/roctogen/latest/roctogen/endpoints/repos/struct.Repos.html)
//!   - [SecretScanning](https://docs.rs/roctogen/latest/roctogen/endpoints/secret_scanning/struct.SecretScanning.html)
//!   - [SecurityAdvisories](https://docs.rs/roctogen/latest/roctogen/endpoints/security_advisories/struct.SecurityAdvisories.html)
//!   - [Packages](https://docs.rs/roctogen/latest/roctogen/endpoints/packages/struct.Packages.html)
//!   - [Search](https://docs.rs/roctogen/latest/roctogen/endpoints/search/struct.Search.html)
//!   - [Classroom](https://docs.rs/roctogen/latest/roctogen/endpoints/classroom/struct.Classroom.html)
//!   - [Teams](https://docs.rs/roctogen/latest/roctogen/endpoints/teams/struct.Teams.html)
//!   - [PrivateRegistries](https://docs.rs/roctogen/latest/roctogen/endpoints/private_registries/struct.PrivateRegistries.html)
//!   - [Oidc](https://docs.rs/roctogen/latest/roctogen/endpoints/oidc/struct.Oidc.html)
//!   - [Markdown](https://docs.rs/roctogen/latest/roctogen/endpoints/markdown/struct.Markdown.html)
//!   - [Actions](https://docs.rs/roctogen/latest/roctogen/endpoints/actions/struct.Actions.html)
//!   - [Migrations](https://docs.rs/roctogen/latest/roctogen/endpoints/migrations/struct.Migrations.html)
//!   - [CodeSecurity](https://docs.rs/roctogen/latest/roctogen/endpoints/code_security/struct.CodeSecurity.html)
//!   - [Gists](https://docs.rs/roctogen/latest/roctogen/endpoints/gists/struct.Gists.html)
//!   - [HostedCompute](https://docs.rs/roctogen/latest/roctogen/endpoints/hosted_compute/struct.HostedCompute.html)
//!   - [Campaigns](https://docs.rs/roctogen/latest/roctogen/endpoints/campaigns/struct.Campaigns.html)
//!   - [DependencyGraph](https://docs.rs/roctogen/latest/roctogen/endpoints/dependency_graph/struct.DependencyGraph.html)
//!   - [Copilot](https://docs.rs/roctogen/latest/roctogen/endpoints/copilot/struct.Copilot.html)
//!   - [Dependabot](https://docs.rs/roctogen/latest/roctogen/endpoints/dependabot/struct.Dependabot.html)
//!   - [CodesOfConduct](https://docs.rs/roctogen/latest/roctogen/endpoints/codes_of_conduct/struct.CodesOfConduct.html)
//!   - [Pulls](https://docs.rs/roctogen/latest/roctogen/endpoints/pulls/struct.Pulls.html)
//!   - [Gitignore](https://docs.rs/roctogen/latest/roctogen/endpoints/gitignore/struct.Gitignore.html)
//!   - [Git](https://docs.rs/roctogen/latest/roctogen/endpoints/git/struct.Git.html)
//!   - [CodeScanning](https://docs.rs/roctogen/latest/roctogen/endpoints/code_scanning/struct.CodeScanning.html)
//!   - [Checks](https://docs.rs/roctogen/latest/roctogen/endpoints/checks/struct.Checks.html)
//!   - [Billing](https://docs.rs/roctogen/latest/roctogen/endpoints/billing/struct.Billing.html)
//!   - [Interactions](https://docs.rs/roctogen/latest/roctogen/endpoints/interactions/struct.Interactions.html)
//!   - [Credentials](https://docs.rs/roctogen/latest/roctogen/endpoints/credentials/struct.Credentials.html)
//!   - [Codespaces](https://docs.rs/roctogen/latest/roctogen/endpoints/codespaces/struct.Codespaces.html)
//!   - [Emojis](https://docs.rs/roctogen/latest/roctogen/endpoints/emojis/struct.Emojis.html)
//!
//! For a full list of supported endpoints, refer to the [API documentation](https://docs.rs/roctogen/latest/roctogen/endpoints/index.html).
//!
//! ## Usage
//!
//! Here's a basic example demonstrating how to use Roctogen:
//!
//! ```no_run
//! use roctogen::api::{self, repos};
//! use roctokit::adapters::client;
//! use roctokit::auth::Auth;
//!
//! let auth = Auth::None;
//! let client = client(&auth).expect("Cannot create new client");
//! let per_page = api::PerPage::new(10);
//! 
//! let mut params: repos::ReposListCommitsParams = per_page.as_ref().into();
//! params = params.author("fussybeaver").page(2);
//!
//! repos::new(&client).list_commits("fussybeaver", "bollard", Some(params));
//! ```
//!
//! ### Asynchronous Requests
//!
//! For async support, use the `_async` suffix for method calls. These are
//! available with the `reqwest`, or WebAssembly targets.
//!
//! ### Webassembly
//!
//! Roctogen can be compiled to WebAssembly using
//! [`wasm-pack`](https://github.com/rustwasm/wasm-pack) or by directly
//! targeting wasm32-unknown-unknown:
//!
//! ```nocompile
//! $ wasm-pack build
//! ```
//!
//! ```nocompile
//! $ cargo build --target wasm32-unknown-unknown
//! ```
//!
//! ## Client adapters
//!
//! Roctogen supports multiple HTTP clients, or you can write your own. Enable
//! the desired client using Cargo features:
//!
//! ### Reqwest
//!
//! Compile with Reqwest support using the `reqwest` feature:
//!
//! ```nocompile
//! $ cargo build --features reqwest
//! ```
//!
//! ### Ureq
//!
//! Compile with Ureq support using the `ureq` feature:
//!
//! ```nocompile
//! $ cargo build --features ureq
//! ```
//!
//! ### Custom Client Adapters
//!
//! It's possible to write your own adapter, by extending
//! `roctogen::adapters::Client`. This allows you to handle rate limiting and
//! pagination - an example of extending the base adapter is available in the
//! example [`min-req-adapter`](/fussybeaver/roctogen/tree/master/examples/min-req-adapter).
//!
//! ## Generating the API
//!
//! Roctogen's code is largely generated from the GitHub REST API specification
//! using the [Swagger OpenAPI
//! generator](https://github.com/swagger-api/swagger-codegen) (version 3).
//! Building the API requires the Java-based `mvn` tool with JDK 8 installed:
//!
//! ```nocompile
//! $ mvn -D org.slf4j.simpleLogger.defaultLogLevel=info clean compiler:compile generate-resources
//! ```
//!
//! ## Testing 
//!
//! Roctogen supports both WebAssembly and synchronous test environments. Be
//! aware that some tests perform real HTTP requests to the GitHub API unless
//! mocked.
//!
//! - **WebAssembly Tests**:
//!
//! ```nocompile
//! $ wasm-pack test --firefox --headless 
//! ```
//!
//! - ** **Synchronous Tests**:
//!
//! ```nocompile
//! $ cargo test --features isahc,mercy,squirrel-girl,inertia,starfox --target x86_64-unknown-linux-gnu -- --nocapture
//! ```
//!
//! To avoid GitHub's API rate limits during testing, you can use WireMock to
//! mock the API locally. Run the following to start WireMock, and run the
//! tests with the `--mock` feature:
//!
//! ```nocompile
//! $ docker run -d --name wiremock -p 8080:8080 -v $PWD/tests/stubs:/home/wiremock
//! rodolpheche/wiremock
//! $ cargo test --features mock,ureq
//! ```
//!
//! ### Regenerate the wiremock stubs
//!
//! If the GitHub API changes, you can regenerate the WireMock stubs:
//!
//! ```nocompile
//! $ docker run -d --name wiremock -p 8080:8080 -v $PWD/tests/stubs:/home/wiremock -u (id -u):(id -g) rodolpheche/wiremock --verbose --proxy-all="https://api.github.com" --record-mappings
//! ```
//!
#![allow(
    missing_docs,
    unused_imports,
)]

#[macro_use]
extern crate serde_derive;

use std::collections::HashMap;

pub mod endpoints;
pub mod models;

pub mod auth {
    
    #[derive(Clone, Debug)]
    pub enum Auth {
        Basic {
            user: String,
            pass: String,
        },
        Token(String),
        Bearer(String),
        None,
    }
}

pub use endpoints as api;