Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.44.2
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Jun 6, 2023
1 parent 9ee08fd commit 1ed92a9
Show file tree
Hide file tree
Showing 81 changed files with 7,057 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.gem
Gemfile.lock
.rbenv-gemsets
53 changes: 53 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
AllCops:
Exclude:
- Rakefile
- test/*.rb
TargetRubyVersion: "3.0"
Metrics:
Enabled: false
Style/IfInsideElse:
Enabled: false
Style/GuardClause:
Enabled: false
Style/ConditionalAssignment:
Enabled: false
Style/Documentation:
Enabled: false
Style/NegatedIf:
Enabled: false
Style/SoleNestedConditional:
Enabled: false
Style/AccessorGrouping:
Enabled: false
Layout/EndAlignment:
EnforcedStyleAlignWith: start_of_line
Enabled: false
Layout/LineLength:
Enabled: false
Lint/EmptyConditionalBody:
Enabled: false
Lint/MissingSuper:
Enabled: false
#To eventually re-enable:
Layout/EmptyLines:
Enabled: false
Layout/EmptyLinesAroundMethodBody:
Enabled: false
Layout/EmptyLineBetweenDefs:
Enabled: false
Layout/EmptyLineAfterGuardClause:
Enabled: false
Layout/EmptyLinesAroundModuleBody:
Enabled: false
Layout/MultilineBlockLayout:
Enabled: false
Lint/UnusedMethodArgument:
Enabled: false
Layout/TrailingWhitespace:
Enabled: false
Style/IfUnlessModifier:
Enabled: false
Naming/AccessorMethodName:
Enabled: false
Naming/MethodParameterName:
Enabled: false
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# frozen_string_literal: true

source 'https://rubygems.org'

# Specify your gem's dependencies in openapi.gemspec
gemspec
116 changes: 116 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<!-- Start SDK Installation -->
## SDK Installation

```bash
gem install speakeasy_client_sdk_ruby
```
<!-- End SDK Installation -->

## SDK Example Usage
<!-- Start SDK Example Usage -->
```ruby
require_relative sdk


s = sdk::SDK.new


req = Operations::Operations::GetApisRequest(
query_params=Operations::GetApisRequest(
metadata={
"provident": [
"quibusdam",
"unde",
"nulla",
],
"corrupti": [
"vel",
"error",
"deserunt",
"suscipit",
],
"iure": [
"debitis",
"ipsa",
],
},
op=Operations::GetApisOp(
and_=false,
),
),
)

res = s.apis::get_apis(req)

if ! res.apis.nil?
# handle response
end

```

<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## Available Resources and Operations

### [SDK](docs/sdk/README.md)

* [validate_api_key](docs/sdk/README.md#validate_api_key) - Validate the current api key.

### [api_endpoints](docs/apiendpoints/README.md)

* [delete_api_endpoint](docs/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
* [find_api_endpoint](docs/apiendpoints/README.md#find_api_endpoint) - Find an ApiEndpoint via its displayName.
* [generate_open_api_spec_for_api_endpoint](docs/apiendpoints/README.md#generate_open_api_spec_for_api_endpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
* [generate_postman_collection_for_api_endpoint](docs/apiendpoints/README.md#generate_postman_collection_for_api_endpoint) - Generate a Postman collection for a particular ApiEndpoint.
* [get_all_api_endpoints](docs/apiendpoints/README.md#get_all_api_endpoints) - Get all Api endpoints for a particular apiID.
* [get_all_for_version_api_endpoints](docs/apiendpoints/README.md#get_all_for_version_api_endpoints) - Get all ApiEndpoints for a particular apiID and versionID.
* [get_api_endpoint](docs/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
* [upsert_api_endpoint](docs/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.

### [apis](docs/apis/README.md)

* [delete_api](docs/apis/README.md#delete_api) - Delete an Api.
* [generate_open_api_spec](docs/apis/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular Api.
* [generate_postman_collection](docs/apis/README.md#generate_postman_collection) - Generate a Postman collection for a particular Api.
* [get_all_api_versions](docs/apis/README.md#get_all_api_versions) - Get all Api versions for a particular ApiEndpoint.
* [get_apis](docs/apis/README.md#get_apis) - Get a list of Apis for a given workspace
* [upsert_api](docs/apis/README.md#upsert_api) - Upsert an Api

### [embeds](docs/embeds/README.md)

* [get_embed_access_token](docs/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
* [get_valid_embed_access_tokens](docs/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
* [revoke_embed_access_token](docs/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.

### [metadata](docs/metadata/README.md)

* [delete_version_metadata](docs/metadata/README.md#delete_version_metadata) - Delete metadata for a particular apiID and versionID.
* [get_version_metadata](docs/metadata/README.md#get_version_metadata) - Get all metadata for a particular apiID and versionID.
* [insert_version_metadata](docs/metadata/README.md#insert_version_metadata) - Insert metadata for a particular apiID and versionID.

### [plugins](docs/plugins/README.md)

* [get_plugins](docs/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
* [run_plugin](docs/plugins/README.md#run_plugin) - Run a plugin
* [upsert_plugin](docs/plugins/README.md#upsert_plugin) - Upsert a plugin

### [requests](docs/requests/README.md)

* [generate_request_postman_collection](docs/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
* [get_request_from_event_log](docs/requests/README.md#get_request_from_event_log) - Get information about a particular request.
* [query_event_log](docs/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.

### [schemas](docs/schemas/README.md)

* [delete_schema](docs/schemas/README.md#delete_schema) - Delete a particular schema revision for an Api.
* [download_schema](docs/schemas/README.md#download_schema) - Download the latest schema for a particular apiID.
* [download_schema_revision](docs/schemas/README.md#download_schema_revision) - Download a particular schema revision for an Api.
* [get_schema](docs/schemas/README.md#get_schema) - Get information about the latest schema.
* [get_schema_diff](docs/schemas/README.md#get_schema_diff) - Get a diff of two schema revisions for an Api.
* [get_schema_revision](docs/schemas/README.md#get_schema_revision) - Get information about a particular schema revision for an Api.
* [get_schemas](docs/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
* [register_schema](docs/schemas/README.md#register_schema) - Register a schema.
<!-- End SDK Available Operations -->

### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
9 changes: 9 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@


## 2023-06-06 16:50:02
### Changes
Based on:
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
- Speakeasy CLI 1.44.2 (2.35.9) https://github.com/speakeasy-api/speakeasy
### Releases
- [Ruby Gems v1.0.1] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/1.0.1 - .
21 changes: 21 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# typed: true
# frozen_string_literal: true

require 'bundler/gem_tasks'
require 'minitest/test_task'
require 'rubocop/rake_task'

RuboCop::RakeTask.new

Minitest::TestTask.create

# So far default is working - leaving this here for reference.

# Minitest::TestTask.create(:test) do |t|
# t.libs << 'test'
# t.libs << 'lib'
# t.warning = false
# t.test_globs = ['test/**/*_test.rb']
# end

task :default => :test
42 changes: 42 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!-- Start SDK Example Usage -->
```ruby
require_relative sdk


s = sdk::SDK.new


req = Operations::Operations::GetApisRequest(
query_params=Operations::GetApisRequest(
metadata={
"provident": [
"quibusdam",
"unde",
"nulla",
],
"corrupti": [
"vel",
"error",
"deserunt",
"suscipit",
],
"iure": [
"debitis",
"ipsa",
],
},
op=Operations::GetApisOp(
and_=false,
),
),
)

res = s.apis::get_apis(req)

if ! res.apis.nil?
# handle response
end

```

<!-- End SDK Example Usage -->
Loading

0 comments on commit 1ed92a9

Please sign in to comment.