Skip to content

Commit 12b7694

Browse files
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.125.2
1 parent d3744de commit 12b7694

24 files changed

+301
-353
lines changed

.rubocop.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,10 @@ Style/TrailingCommaInArrayLiteral:
6363
Layout/EmptyLinesAroundClassBody:
6464
Enabled: false
6565
Style/WordArray:
66-
Enabled: false
66+
Enabled: false
67+
Style/RedundantReturn: # https://github.com/rubocop/rubocop/issues/12394
68+
Enabled: false
69+
Style/RedundantAssignment:
70+
Enabled: false
71+
Lint/LiteralAsCondition:
72+
Enabled: false

README.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
<!-- Start SDK Installation -->
1+
<!-- Start SDK Installation [installation] -->
22
## SDK Installation
33

44
```bash
55
gem install speakeasy_client_sdk_ruby
66
```
7-
<!-- End SDK Installation -->
7+
<!-- End SDK Installation [installation] -->
88

9+
<!-- Start SDK Example Usage [usage] -->
910
## SDK Example Usage
10-
<!-- Start SDK Example Usage -->
11+
1112
### Example
1213

1314
```ruby
@@ -17,21 +18,19 @@ require_relative speakeasy_client_sdk_ruby
1718
s = SpeakeasyClientSDK::SDK.new
1819
s.config_security(
1920
security=Shared::Security.new(
20-
api_key=.foo"",
21+
api_key="",
2122
)
2223
)
2324

24-
25+
2526
req = Operations::GetApisRequest.new(
26-
query_params=Operations::GetApisRequest.new(
27-
metadata=.new{
28-
"South": .new[
29-
"string",
30-
],
31-
},
32-
op=Operations::QueryParamOp.new(
33-
and_=false,
34-
),
27+
metadata={
28+
"South": [
29+
"string",
30+
],
31+
},
32+
op=Operations::QueryParamOp.new(
33+
and_=false,
3534
),
3635
)
3736

@@ -42,9 +41,9 @@ if ! res.classes.nil?
4241
end
4342

4443
```
45-
<!-- End SDK Example Usage -->
44+
<!-- End SDK Example Usage [usage] -->
4645

47-
<!-- Start SDK Available Operations -->
46+
<!-- Start Available Resources and Operations [operations] -->
4847
## Available Resources and Operations
4948

5049
### [SDK](docs/sdks/sdk/README.md)
@@ -105,13 +104,29 @@ end
105104
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
106105
* [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
107106
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
108-
<!-- End SDK Available Operations -->
107+
<!-- End Available Resources and Operations [operations] -->
108+
109+
110+
111+
<!-- Start Server Selection [server] -->
112+
## Server Selection
113+
114+
## Server Selection
115+
116+
### Select Server by Name
117+
118+
You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
119+
120+
| Name | Server | Variables |
121+
| ----- | ------ | --------- |
122+
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
109123

110124

111125

112-
<!-- Start Dev Containers -->
126+
### Override Server URL Per-Client
113127

114-
<!-- End Dev Containers -->
128+
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
129+
<!-- End Server Selection [server] -->
115130

116131
<!-- Placeholder for Future Speakeasy SDK Sections -->
117132

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,4 +478,14 @@ Based on:
478478
### Generated
479479
- [ruby v2.1.2] .
480480
### Releases
481-
- [Ruby Gems v2.1.2] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/2.1.2 - .
481+
- [Ruby Gems v2.1.2] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/2.1.2 - .
482+
483+
## 2023-12-06 00:03:01
484+
### Changes
485+
Based on:
486+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
487+
- Speakeasy CLI 1.125.2 (2.210.6) https://github.com/speakeasy-api/speakeasy
488+
### Generated
489+
- [ruby v2.1.3] .
490+
### Releases
491+
- [Ruby Gems v2.1.3] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/2.1.3 - .

USAGE.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
<!-- Start SDK Example Usage -->
1+
<!-- Start SDK Example Usage [usage] -->
22
```ruby
33
require_relative speakeasy_client_sdk_ruby
44

55

66
s = SpeakeasyClientSDK::SDK.new
77
s.config_security(
88
security=Shared::Security.new(
9-
api_key=.foo"",
9+
api_key="",
1010
)
1111
)
1212

13-
13+
1414
req = Operations::GetApisRequest.new(
15-
query_params=Operations::GetApisRequest.new(
16-
metadata=.new{
17-
"South": .new[
18-
"string",
19-
],
20-
},
21-
op=Operations::QueryParamOp.new(
22-
and_=false,
23-
),
15+
metadata={
16+
"South": [
17+
"string",
18+
],
19+
},
20+
op=Operations::QueryParamOp.new(
21+
and_=false,
2422
),
2523
)
2624

@@ -31,4 +29,4 @@ if ! res.classes.nil?
3129
end
3230

3331
```
34-
<!-- End SDK Example Usage -->
32+
<!-- End SDK Example Usage [usage] -->

docs/sdks/apiendpoints/README.md

Lines changed: 39 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,15 @@ require_relative speakeasy_client_sdk_ruby
2929
s = SpeakeasyClientSDK::SDK.new
3030
s.config_security(
3131
security=Shared::Security.new(
32-
api_key=.foo"",
32+
api_key="",
3333
)
3434
)
3535

36-
36+
3737
req = Operations::DeleteApiEndpointRequest.new(
38-
path_params=Operations::DeleteApiEndpointRequest.new(
39-
api_endpoint_id="string",
40-
api_id="string",
41-
version_id="string",
42-
),
38+
api_endpoint_id="string",
39+
api_id="string",
40+
version_id="string",
4341
)
4442

4543
res = s.api_endpoints.delete_api_endpoint(req)
@@ -76,17 +74,15 @@ require_relative speakeasy_client_sdk_ruby
7674
s = SpeakeasyClientSDK::SDK.new
7775
s.config_security(
7876
security=Shared::Security.new(
79-
api_key=.foo"",
77+
api_key="",
8078
)
8179
)
8280

83-
81+
8482
req = Operations::FindApiEndpointRequest.new(
85-
path_params=Operations::FindApiEndpointRequest.new(
86-
api_id="string",
87-
display_name="string",
88-
version_id="string",
89-
),
83+
api_id="string",
84+
display_name="string",
85+
version_id="string",
9086
)
9187

9288
res = s.api_endpoints.find_api_endpoint(req)
@@ -123,17 +119,15 @@ require_relative speakeasy_client_sdk_ruby
123119
s = SpeakeasyClientSDK::SDK.new
124120
s.config_security(
125121
security=Shared::Security.new(
126-
api_key=.foo"",
122+
api_key="",
127123
)
128124
)
129125

130-
126+
131127
req = Operations::GenerateOpenApiSpecForApiEndpointRequest.new(
132-
path_params=Operations::GenerateOpenApiSpecForApiEndpointRequest.new(
133-
api_endpoint_id="string",
134-
api_id="string",
135-
version_id="string",
136-
),
128+
api_endpoint_id="string",
129+
api_id="string",
130+
version_id="string",
137131
)
138132

139133
res = s.api_endpoints.generate_open_api_spec_for_api_endpoint(req)
@@ -169,17 +163,15 @@ require_relative speakeasy_client_sdk_ruby
169163
s = SpeakeasyClientSDK::SDK.new
170164
s.config_security(
171165
security=Shared::Security.new(
172-
api_key=.foo"",
166+
api_key="",
173167
)
174168
)
175169

176-
170+
177171
req = Operations::GeneratePostmanCollectionForApiEndpointRequest.new(
178-
path_params=Operations::GeneratePostmanCollectionForApiEndpointRequest.new(
179-
api_endpoint_id="string",
180-
api_id="string",
181-
version_id="string",
182-
),
172+
api_endpoint_id="string",
173+
api_id="string",
174+
version_id="string",
183175
)
184176

185177
res = s.api_endpoints.generate_postman_collection_for_api_endpoint(req)
@@ -215,15 +207,13 @@ require_relative speakeasy_client_sdk_ruby
215207
s = SpeakeasyClientSDK::SDK.new
216208
s.config_security(
217209
security=Shared::Security.new(
218-
api_key=.foo"",
210+
api_key="",
219211
)
220212
)
221213

222-
214+
223215
req = Operations::GetAllApiEndpointsRequest.new(
224-
path_params=Operations::GetAllApiEndpointsRequest.new(
225-
api_id="string",
226-
),
216+
api_id="string",
227217
)
228218

229219
res = s.api_endpoints.get_all_api_endpoints(req)
@@ -259,16 +249,14 @@ require_relative speakeasy_client_sdk_ruby
259249
s = SpeakeasyClientSDK::SDK.new
260250
s.config_security(
261251
security=Shared::Security.new(
262-
api_key=.foo"",
252+
api_key="",
263253
)
264254
)
265255

266-
256+
267257
req = Operations::GetAllForVersionApiEndpointsRequest.new(
268-
path_params=Operations::GetAllForVersionApiEndpointsRequest.new(
269-
api_id="string",
270-
version_id="string",
271-
),
258+
api_id="string",
259+
version_id="string",
272260
)
273261

274262
res = s.api_endpoints.get_all_for_version_api_endpoints(req)
@@ -304,17 +292,15 @@ require_relative speakeasy_client_sdk_ruby
304292
s = SpeakeasyClientSDK::SDK.new
305293
s.config_security(
306294
security=Shared::Security.new(
307-
api_key=.foo"",
295+
api_key="",
308296
)
309297
)
310298

311-
299+
312300
req = Operations::GetApiEndpointRequest.new(
313-
path_params=Operations::GetApiEndpointRequest.new(
314-
api_endpoint_id="string",
315-
api_id="string",
316-
version_id="string",
317-
),
301+
api_endpoint_id="string",
302+
api_id="string",
303+
version_id="string",
318304
)
319305

320306
res = s.api_endpoints.get_api_endpoint(req)
@@ -350,33 +336,23 @@ require_relative speakeasy_client_sdk_ruby
350336
s = SpeakeasyClientSDK::SDK.new
351337
s.config_security(
352338
security=Shared::Security.new(
353-
api_key=.foo"",
339+
api_key="",
354340
)
355341
)
356342

357-
343+
358344
req = Operations::UpsertApiEndpointRequest.new(
359-
path_params=Operations::UpsertApiEndpointRequest.new(
360-
api_endpoint=Shared::ApiEndpointInput.new(
361-
api_endpoint_id="string",
362-
description="Public-key systematic attitude",
363-
display_name="string",
364-
method="string",
365-
path="/etc/periodic",
366-
version_id="string",
367-
),
368-
api_endpoint_id="string",
369-
api_id="string",
370-
version_id="string",
371-
),
372345
api_endpoint=Shared::ApiEndpointInput.new(
373346
api_endpoint_id="string",
374-
description="Seamless transitional hub",
347+
description="Public-key systematic attitude",
375348
display_name="string",
376349
method="string",
377-
path="/etc/defaults",
350+
path="/etc/periodic",
378351
version_id="string",
379352
),
353+
api_endpoint_id="string",
354+
api_id="string",
355+
version_id="string",
380356
)
381357

382358
res = s.api_endpoints.upsert_api_endpoint(req)

0 commit comments

Comments
 (0)