Skip to content

Commit 8e3e895

Browse files
authored
docs: openapi-generator README and rustdoc improvements (#4)
Upstream PR: OpenAPITools/openapi-generator#10461
1 parent f2b1b9b commit 8e3e895

File tree

68 files changed

+3535
-3501
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+3535
-3501
lines changed

twilio-oai-accounts-v1/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
This is the public Twilio REST API.
44

5+
For more information, please visit [https://support.twilio.com](https://support.twilio.com)
6+
57
## Overview
68

79
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
810

911
- API version: 1.20.3
1012
- Package version: 0.20.3
11-
- Build package: org.openapitools.codegen.languages.RustClientCodegen
12-
For more information, please visit [https://support.twilio.com](https://support.twilio.com)
13+
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
1314

1415
## Installation
1516

1617
Put the package under your project folder and add the following to `Cargo.toml` under `[dependencies]`:
1718

1819
```
19-
openapi = { path = "./generated" }
20+
twilio-oai-accounts-v1 = { path = "./generated" }
2021
```
2122

2223
## Documentation

twilio-oai-accounts-v1/src/apis/default_api.rs

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use reqwest;
1414
use crate::apis::ResponseContent;
1515
use super::{Error, configuration};
1616

17-
/// struct for passing parameters to the method `create_credential_aws`
17+
/// struct for passing parameters to the method [`create_credential_aws`]
1818
#[derive(Clone, Debug, Default)]
1919
pub struct CreateCredentialAwsParams {
2020
/// A string that contains the AWS access credentials in the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
@@ -25,7 +25,7 @@ pub struct CreateCredentialAwsParams {
2525
pub friendly_name: Option<String>
2626
}
2727

28-
/// struct for passing parameters to the method `create_credential_public_key`
28+
/// struct for passing parameters to the method [`create_credential_public_key`]
2929
#[derive(Clone, Debug, Default)]
3030
pub struct CreateCredentialPublicKeyParams {
3131
/// A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----`
@@ -36,49 +36,49 @@ pub struct CreateCredentialPublicKeyParams {
3636
pub friendly_name: Option<String>
3737
}
3838

39-
/// struct for passing parameters to the method `delete_credential_aws`
39+
/// struct for passing parameters to the method [`delete_credential_aws`]
4040
#[derive(Clone, Debug, Default)]
4141
pub struct DeleteCredentialAwsParams {
4242
/// The Twilio-provided string that uniquely identifies the AWS resource to delete.
4343
pub sid: String
4444
}
4545

46-
/// struct for passing parameters to the method `delete_credential_public_key`
46+
/// struct for passing parameters to the method [`delete_credential_public_key`]
4747
#[derive(Clone, Debug, Default)]
4848
pub struct DeleteCredentialPublicKeyParams {
4949
/// The Twilio-provided string that uniquely identifies the PublicKey resource to delete.
5050
pub sid: String
5151
}
5252

53-
/// struct for passing parameters to the method `fetch_credential_aws`
53+
/// struct for passing parameters to the method [`fetch_credential_aws`]
5454
#[derive(Clone, Debug, Default)]
5555
pub struct FetchCredentialAwsParams {
5656
/// The Twilio-provided string that uniquely identifies the AWS resource to fetch.
5757
pub sid: String
5858
}
5959

60-
/// struct for passing parameters to the method `fetch_credential_public_key`
60+
/// struct for passing parameters to the method [`fetch_credential_public_key`]
6161
#[derive(Clone, Debug, Default)]
6262
pub struct FetchCredentialPublicKeyParams {
6363
/// The Twilio-provided string that uniquely identifies the PublicKey resource to fetch.
6464
pub sid: String
6565
}
6666

67-
/// struct for passing parameters to the method `list_credential_aws`
67+
/// struct for passing parameters to the method [`list_credential_aws`]
6868
#[derive(Clone, Debug, Default)]
6969
pub struct ListCredentialAwsParams {
7070
/// How many resources to return in each list page. The default is 50, and the maximum is 1000.
7171
pub page_size: Option<i32>
7272
}
7373

74-
/// struct for passing parameters to the method `list_credential_public_key`
74+
/// struct for passing parameters to the method [`list_credential_public_key`]
7575
#[derive(Clone, Debug, Default)]
7676
pub struct ListCredentialPublicKeyParams {
7777
/// How many resources to return in each list page. The default is 50, and the maximum is 1000.
7878
pub page_size: Option<i32>
7979
}
8080

81-
/// struct for passing parameters to the method `update_credential_aws`
81+
/// struct for passing parameters to the method [`update_credential_aws`]
8282
#[derive(Clone, Debug, Default)]
8383
pub struct UpdateCredentialAwsParams {
8484
/// The Twilio-provided string that uniquely identifies the AWS resource to update.
@@ -87,7 +87,7 @@ pub struct UpdateCredentialAwsParams {
8787
pub friendly_name: Option<String>
8888
}
8989

90-
/// struct for passing parameters to the method `update_credential_public_key`
90+
/// struct for passing parameters to the method [`update_credential_public_key`]
9191
#[derive(Clone, Debug, Default)]
9292
pub struct UpdateCredentialPublicKeyParams {
9393
/// The Twilio-provided string that uniquely identifies the PublicKey resource to update.
@@ -97,195 +97,195 @@ pub struct UpdateCredentialPublicKeyParams {
9797
}
9898

9999

100-
/// struct for typed successes of method `create_credential_aws`
100+
/// struct for typed successes of method [`create_credential_aws`]
101101
#[derive(Debug, Clone, Serialize, Deserialize)]
102102
#[serde(untagged)]
103103
pub enum CreateCredentialAwsSuccess {
104104
Status201(crate::models::AccountsV1CredentialCredentialAws),
105105
UnknownValue(serde_json::Value),
106106
}
107107

108-
/// struct for typed successes of method `create_credential_public_key`
108+
/// struct for typed successes of method [`create_credential_public_key`]
109109
#[derive(Debug, Clone, Serialize, Deserialize)]
110110
#[serde(untagged)]
111111
pub enum CreateCredentialPublicKeySuccess {
112112
Status201(crate::models::AccountsV1CredentialCredentialPublicKey),
113113
UnknownValue(serde_json::Value),
114114
}
115115

116-
/// struct for typed successes of method `create_secondary_auth_token`
116+
/// struct for typed successes of method [`create_secondary_auth_token`]
117117
#[derive(Debug, Clone, Serialize, Deserialize)]
118118
#[serde(untagged)]
119119
pub enum CreateSecondaryAuthTokenSuccess {
120120
Status201(crate::models::AccountsV1SecondaryAuthToken),
121121
UnknownValue(serde_json::Value),
122122
}
123123

124-
/// struct for typed successes of method `delete_credential_aws`
124+
/// struct for typed successes of method [`delete_credential_aws`]
125125
#[derive(Debug, Clone, Serialize, Deserialize)]
126126
#[serde(untagged)]
127127
pub enum DeleteCredentialAwsSuccess {
128128
Status204(),
129129
UnknownValue(serde_json::Value),
130130
}
131131

132-
/// struct for typed successes of method `delete_credential_public_key`
132+
/// struct for typed successes of method [`delete_credential_public_key`]
133133
#[derive(Debug, Clone, Serialize, Deserialize)]
134134
#[serde(untagged)]
135135
pub enum DeleteCredentialPublicKeySuccess {
136136
Status204(),
137137
UnknownValue(serde_json::Value),
138138
}
139139

140-
/// struct for typed successes of method `delete_secondary_auth_token`
140+
/// struct for typed successes of method [`delete_secondary_auth_token`]
141141
#[derive(Debug, Clone, Serialize, Deserialize)]
142142
#[serde(untagged)]
143143
pub enum DeleteSecondaryAuthTokenSuccess {
144144
Status204(),
145145
UnknownValue(serde_json::Value),
146146
}
147147

148-
/// struct for typed successes of method `fetch_credential_aws`
148+
/// struct for typed successes of method [`fetch_credential_aws`]
149149
#[derive(Debug, Clone, Serialize, Deserialize)]
150150
#[serde(untagged)]
151151
pub enum FetchCredentialAwsSuccess {
152152
Status200(crate::models::AccountsV1CredentialCredentialAws),
153153
UnknownValue(serde_json::Value),
154154
}
155155

156-
/// struct for typed successes of method `fetch_credential_public_key`
156+
/// struct for typed successes of method [`fetch_credential_public_key`]
157157
#[derive(Debug, Clone, Serialize, Deserialize)]
158158
#[serde(untagged)]
159159
pub enum FetchCredentialPublicKeySuccess {
160160
Status200(crate::models::AccountsV1CredentialCredentialPublicKey),
161161
UnknownValue(serde_json::Value),
162162
}
163163

164-
/// struct for typed successes of method `list_credential_aws`
164+
/// struct for typed successes of method [`list_credential_aws`]
165165
#[derive(Debug, Clone, Serialize, Deserialize)]
166166
#[serde(untagged)]
167167
pub enum ListCredentialAwsSuccess {
168168
Status200(crate::models::ListCredentialAwsResponse),
169169
UnknownValue(serde_json::Value),
170170
}
171171

172-
/// struct for typed successes of method `list_credential_public_key`
172+
/// struct for typed successes of method [`list_credential_public_key`]
173173
#[derive(Debug, Clone, Serialize, Deserialize)]
174174
#[serde(untagged)]
175175
pub enum ListCredentialPublicKeySuccess {
176176
Status200(crate::models::ListCredentialPublicKeyResponse),
177177
UnknownValue(serde_json::Value),
178178
}
179179

180-
/// struct for typed successes of method `update_auth_token_promotion`
180+
/// struct for typed successes of method [`update_auth_token_promotion`]
181181
#[derive(Debug, Clone, Serialize, Deserialize)]
182182
#[serde(untagged)]
183183
pub enum UpdateAuthTokenPromotionSuccess {
184184
Status200(crate::models::AccountsV1AuthTokenPromotion),
185185
UnknownValue(serde_json::Value),
186186
}
187187

188-
/// struct for typed successes of method `update_credential_aws`
188+
/// struct for typed successes of method [`update_credential_aws`]
189189
#[derive(Debug, Clone, Serialize, Deserialize)]
190190
#[serde(untagged)]
191191
pub enum UpdateCredentialAwsSuccess {
192192
Status200(crate::models::AccountsV1CredentialCredentialAws),
193193
UnknownValue(serde_json::Value),
194194
}
195195

196-
/// struct for typed successes of method `update_credential_public_key`
196+
/// struct for typed successes of method [`update_credential_public_key`]
197197
#[derive(Debug, Clone, Serialize, Deserialize)]
198198
#[serde(untagged)]
199199
pub enum UpdateCredentialPublicKeySuccess {
200200
Status200(crate::models::AccountsV1CredentialCredentialPublicKey),
201201
UnknownValue(serde_json::Value),
202202
}
203203

204-
/// struct for typed errors of method `create_credential_aws`
204+
/// struct for typed errors of method [`create_credential_aws`]
205205
#[derive(Debug, Clone, Serialize, Deserialize)]
206206
#[serde(untagged)]
207207
pub enum CreateCredentialAwsError {
208208
UnknownValue(serde_json::Value),
209209
}
210210

211-
/// struct for typed errors of method `create_credential_public_key`
211+
/// struct for typed errors of method [`create_credential_public_key`]
212212
#[derive(Debug, Clone, Serialize, Deserialize)]
213213
#[serde(untagged)]
214214
pub enum CreateCredentialPublicKeyError {
215215
UnknownValue(serde_json::Value),
216216
}
217217

218-
/// struct for typed errors of method `create_secondary_auth_token`
218+
/// struct for typed errors of method [`create_secondary_auth_token`]
219219
#[derive(Debug, Clone, Serialize, Deserialize)]
220220
#[serde(untagged)]
221221
pub enum CreateSecondaryAuthTokenError {
222222
UnknownValue(serde_json::Value),
223223
}
224224

225-
/// struct for typed errors of method `delete_credential_aws`
225+
/// struct for typed errors of method [`delete_credential_aws`]
226226
#[derive(Debug, Clone, Serialize, Deserialize)]
227227
#[serde(untagged)]
228228
pub enum DeleteCredentialAwsError {
229229
UnknownValue(serde_json::Value),
230230
}
231231

232-
/// struct for typed errors of method `delete_credential_public_key`
232+
/// struct for typed errors of method [`delete_credential_public_key`]
233233
#[derive(Debug, Clone, Serialize, Deserialize)]
234234
#[serde(untagged)]
235235
pub enum DeleteCredentialPublicKeyError {
236236
UnknownValue(serde_json::Value),
237237
}
238238

239-
/// struct for typed errors of method `delete_secondary_auth_token`
239+
/// struct for typed errors of method [`delete_secondary_auth_token`]
240240
#[derive(Debug, Clone, Serialize, Deserialize)]
241241
#[serde(untagged)]
242242
pub enum DeleteSecondaryAuthTokenError {
243243
UnknownValue(serde_json::Value),
244244
}
245245

246-
/// struct for typed errors of method `fetch_credential_aws`
246+
/// struct for typed errors of method [`fetch_credential_aws`]
247247
#[derive(Debug, Clone, Serialize, Deserialize)]
248248
#[serde(untagged)]
249249
pub enum FetchCredentialAwsError {
250250
UnknownValue(serde_json::Value),
251251
}
252252

253-
/// struct for typed errors of method `fetch_credential_public_key`
253+
/// struct for typed errors of method [`fetch_credential_public_key`]
254254
#[derive(Debug, Clone, Serialize, Deserialize)]
255255
#[serde(untagged)]
256256
pub enum FetchCredentialPublicKeyError {
257257
UnknownValue(serde_json::Value),
258258
}
259259

260-
/// struct for typed errors of method `list_credential_aws`
260+
/// struct for typed errors of method [`list_credential_aws`]
261261
#[derive(Debug, Clone, Serialize, Deserialize)]
262262
#[serde(untagged)]
263263
pub enum ListCredentialAwsError {
264264
UnknownValue(serde_json::Value),
265265
}
266266

267-
/// struct for typed errors of method `list_credential_public_key`
267+
/// struct for typed errors of method [`list_credential_public_key`]
268268
#[derive(Debug, Clone, Serialize, Deserialize)]
269269
#[serde(untagged)]
270270
pub enum ListCredentialPublicKeyError {
271271
UnknownValue(serde_json::Value),
272272
}
273273

274-
/// struct for typed errors of method `update_auth_token_promotion`
274+
/// struct for typed errors of method [`update_auth_token_promotion`]
275275
#[derive(Debug, Clone, Serialize, Deserialize)]
276276
#[serde(untagged)]
277277
pub enum UpdateAuthTokenPromotionError {
278278
UnknownValue(serde_json::Value),
279279
}
280280

281-
/// struct for typed errors of method `update_credential_aws`
281+
/// struct for typed errors of method [`update_credential_aws`]
282282
#[derive(Debug, Clone, Serialize, Deserialize)]
283283
#[serde(untagged)]
284284
pub enum UpdateCredentialAwsError {
285285
UnknownValue(serde_json::Value),
286286
}
287287

288-
/// struct for typed errors of method `update_credential_public_key`
288+
/// struct for typed errors of method [`update_credential_public_key`]
289289
#[derive(Debug, Clone, Serialize, Deserialize)]
290290
#[serde(untagged)]
291291
pub enum UpdateCredentialPublicKeyError {

twilio-oai-api-v2010/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
This is the public Twilio REST API.
44

5+
For more information, please visit [https://support.twilio.com](https://support.twilio.com)
6+
57
## Overview
68

79
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
810

911
- API version: 1.20.3
1012
- Package version: 0.20.3
11-
- Build package: org.openapitools.codegen.languages.RustClientCodegen
12-
For more information, please visit [https://support.twilio.com](https://support.twilio.com)
13+
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
1314

1415
## Installation
1516

1617
Put the package under your project folder and add the following to `Cargo.toml` under `[dependencies]`:
1718

1819
```
19-
openapi = { path = "./generated" }
20+
twilio-oai-api-v2010 = { path = "./generated" }
2021
```
2122

2223
## Documentation

0 commit comments

Comments
 (0)