gem install speakeasy_client_sdk_rubyrequire 'speakeasy_client_sdk_ruby'
s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
::SpeakeasyClientSDK::Shared::Security.new(
api_key: "<YOUR_API_KEY_HERE>",
)
)
req = ::SpeakeasyClientSDK::Operations::GetApisRequest.new()
res = s.apis.get_apis(req)
if ! res.apis.nil?
# handle response
end- delete_api - Delete an Api.
- generate_open_api_spec - Generate an OpenAPI specification for a particular Api.
- generate_postman_collection - Generate a Postman collection for a particular Api.
- get_all_api_versions - Get all Api versions for a particular ApiEndpoint.
- get_apis - Get a list of Apis for a given workspace
- upsert_api - Upsert an Api
- delete_api_endpoint - Delete an ApiEndpoint.
- find_api_endpoint - Find an ApiEndpoint via its displayName.
- generate_open_api_spec_for_api_endpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
- generate_postman_collection_for_api_endpoint - Generate a Postman collection for a particular ApiEndpoint.
- get_all_api_endpoints - Get all Api endpoints for a particular apiID.
- get_all_for_version_api_endpoints - Get all ApiEndpoints for a particular apiID and versionID.
- get_api_endpoint - Get an ApiEndpoint.
- upsert_api_endpoint - Upsert an ApiEndpoint.
- delete_version_metadata - Delete metadata for a particular apiID and versionID.
- get_version_metadata - Get all metadata for a particular apiID and versionID.
- insert_version_metadata - Insert metadata for a particular apiID and versionID.
- delete_schema - Delete a particular schema revision for an Api.
- download_schema - Download the latest schema for a particular apiID.
- download_schema_revision - Download a particular schema revision for an Api.
- get_schema - Get information about the latest schema.
- get_schema_diff - Get a diff of two schema revisions for an Api.
- get_schema_revision - Get information about a particular schema revision for an Api.
- get_schemas - Get information about all schemas associated with a particular apiID.
- register_schema - Register a schema.
- get_blob - Get blob for a particular digest
- get_manifest - Get manifest for a particular reference
- get_namespaces - Each namespace contains many revisions.
- get_oas_summary
- get_revisions
- get_tags
- post_tags - Add tags to an existing revision
- preflight - Get access token for communicating with OCI distribution endpoints
- get_access_token - Get or refresh an access token for the current workspace.
- get_user - Get information about the current user.
- get_workspace_access - Get access allowances for a particular workspace
- validate_api_key - Validate the current api key.
- generate_request_postman_collection - Generate a Postman collection for a particular request.
- get_request_from_event_log - Get information about a particular request.
- query_event_log - Query the event log to retrieve a list of requests.
- check_access
- configure_code_samples
- configure_mintlify_repo
- configure_target
- fetch_publishing_p_rs
- get_action
- github_check_publishing_secrets
- github_store_publishing_secrets
- trigger_action
- create_free_trial - Create a free trial for an organization
- get_organization - Get organization
- get_organization_usage - Get billing usage summary for a particular organization
- get_organizations - Get organizations for a user
- get_changes_report_signed_url - Get the signed access url for the change reports for a particular document.
- get_linting_report_signed_url - Get the signed access url for the linting reports for a particular document.
- upload_report - Upload a report.
- create - Shorten a URL.
- apply_operation_i_ds - Apply operation ID suggestions and download result.
- suggest_operation_i_ds - Generate operation ID suggestions.
- suggest_operation_i_ds_registry - Generate operation ID suggestions.
- get_embed_access_token - Get an embed access token for the current workspace.
- get_valid_embed_access_tokens - Get all valid embed access tokens for the current workspace.
- revoke_embed_access_token - Revoke an embed access EmbedToken.
- get_workspace - Get workspace
- get_workspace_events_by_target - Load recent events for a particular workspace
- get_workspace_targets - Load targets for a particular workspace
- post_workspace_events - Post events for a specific workspace
- search_workspace_events - Search events for a particular workspace by any field
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:
| Name | Server | Variables |
|---|---|---|
prod |
https://api.prod.speakeasyapi.dev |
None |
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:
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.
For example, you can set workspaceID to "<value>" at SDK initialization and then you do not have to pass the same value on calls to operations like get_workspace. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Required | Description |
|---|---|---|---|
| workspace_id | ::String | The workspace_id parameter. |
require 'speakeasy_client_sdk_ruby'
s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
::SpeakeasyClientSDK::Shared::Security.new(
api_key: "<YOUR_API_KEY_HERE>",
)
)
req = ::SpeakeasyClientSDK::Operations::GetWorkspaceRequest.new()
res = s.workspaces.get_workspace(req)
if ! res.workspace.nil?
# handle response
end