You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
86
+
*[find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
87
+
*[delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
88
+
*[get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
89
+
*[upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
90
+
*[generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
91
+
*[generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
*[get_all](docs/sdks/organizations/README.md#get_all) - Get organizations for a user
147
163
*[create](docs/sdks/organizations/README.md#create) - Create an organization
148
164
*[get](docs/sdks/organizations/README.md#get) - Get organization
149
165
*[create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization
150
166
*[get_usage](docs/sdks/organizations/README.md#get_usage) - Get billing usage summary for a particular organization
151
167
152
-
### [Reports](docs/sdks/reports/README.md)
168
+
### [reports](docs/sdks/reports/README.md)
153
169
154
170
*[upload](docs/sdks/reports/README.md#upload) - Upload a report.
155
171
*[get_signed_url](docs/sdks/reports/README.md#get_signed_url) - Get the signed access url for the linting reports for a particular document.
156
172
*[get_changes_signed_url](docs/sdks/reports/README.md#get_changes_signed_url) - Get the signed access url for the change reports for a particular document.
157
173
158
-
### [Requests](docs/sdks/requests/README.md)
174
+
### [requests](docs/sdks/requests/README.md)
159
175
160
176
*[query](docs/sdks/requests/README.md#query) - Query the event log to retrieve a list of requests.
161
177
*[get](docs/sdks/requests/README.md#get) - Get information about a particular request.
162
178
*[generate_postman_collection](docs/sdks/requests/README.md#generate_postman_collection) - Generate a Postman collection for a particular request.
163
179
164
-
### [Schemas](docs/sdks/schemas/README.md)
180
+
### [schemas](docs/sdks/schemas/README.md)
165
181
166
182
*[get_latest](docs/sdks/schemas/README.md#get_latest) - Get information about the latest schema.
167
183
*[post](docs/sdks/schemas/README.md#post) - Register a schema.
@@ -172,28 +188,29 @@ end
172
188
*[download_revision](docs/sdks/schemas/README.md#download_revision) - Download a particular schema revision for an Api.
173
189
*[get](docs/sdks/schemas/README.md#get) - Get information about all schemas associated with a particular apiID.
174
190
175
-
### [ShortURLs](docs/sdks/shorturls/README.md)
191
+
### [short_ur_ls](docs/sdks/shorturls/README.md)
176
192
177
193
*[create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
*[generate_code_sample_preview](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters.
198
+
*[generate_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview_async) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.
199
+
*[get_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#get_code_sample_preview_async) - Poll for the result of an asynchronous Code Sample preview generation.
181
200
182
-
*[get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
183
-
*[find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
184
-
*[delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
185
-
*[get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
186
-
*[upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
187
-
*[generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
188
-
*[generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
*[openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
193
209
*[generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document.
210
+
*[suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items.
194
211
*[openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry.
195
212
196
-
### [Workspaces](docs/sdks/workspaces/README.md)
213
+
### [workspaces](docs/sdks/workspaces/README.md)
197
214
198
215
*[get_all](docs/sdks/workspaces/README.md#get_all) - Get workspaces for a user
199
216
*[get](docs/sdks/workspaces/README.md#get) - Get workspace by context
@@ -213,24 +230,119 @@ end
213
230
</details>
214
231
<!-- End Available Resources and Operations [operations] -->
215
232
216
-
<!-- Start Server Selection [server] -->
217
-
## Server Selection
233
+
<!-- Start Global Parameters [global-parameters] -->
234
+
## Global Parameters
235
+
236
+
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
237
+
238
+
For example, you can set `workspace_id` to `"<id>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_access_token`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
| workspace_id | ::String | The workspace_id parameter. |
248
+
249
+
### Example
250
+
251
+
```ruby
252
+
require'speakeasy_client_sdk_ruby'
253
+
254
+
255
+
s = ::OpenApiSDK::SpeakeasyClientSDK.new
256
+
257
+
258
+
res = s.auth.get_access_token(workspace_id="<id>")
259
+
260
+
if! res.access_token.nil?
261
+
# handle response
262
+
end
263
+
264
+
```
265
+
<!-- End Global Parameters [global-parameters] -->
266
+
267
+
<!-- Start Server Selection [server] -->
219
268
## Server Selection
220
269
221
270
### Select Server by Name
222
271
223
-
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:
272
+
You can override the default server globally by passing a server name to the `server (Symbol)` 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:
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:
314
+
The default server can also be overridden globally by passing a URL to the `server_url (String)` optional parameter when initializing the SDK client instance. For example:
|`content_type`|*::String*|:heavy_check_mark:| HTTP response content type for this operation |
9
+
|`status_code`|*::Integer*|:heavy_check_mark:| HTTP response status code for this operation |
10
+
|`raw_response`|[Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response)|:heavy_check_mark:| Raw HTTP response; suitable for custom response parsing |
0 commit comments