Skip to content

Commit dfc8a05

Browse files
TristanSpeakEasyTristanSpeakEasy
committed
chore: inital ruby generation
1 parent d0be6b7 commit dfc8a05

Some content is hidden

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

70 files changed

+5547
-0
lines changed

‎Gemfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
# Specify your gem's dependencies in openapi.gemspec
6+
gemspec

‎README.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<!-- Start SDK Installation -->
2+
## SDK Installation
3+
4+
```bash
5+
gem install openapi
6+
```
7+
<!-- End SDK Installation -->
8+
9+
## SDK Example Usage
10+
<!-- Start SDK Example Usage -->
11+
```ruby
12+
require_relative sdk
13+
14+
s = sdk::SDK.new()
15+
s.config_security(
16+
security=Shared::Security(
17+
api_key="YOUR_API_KEY_HERE",
18+
)
19+
)
20+
21+
req = operations.Operations::GetApisRequest(
22+
query_params=Operations::GetApisQueryParams(
23+
metadata={
24+
"deserunt": [
25+
"nulla",
26+
"id",
27+
"vero",
28+
],
29+
"perspiciatis": [
30+
"nihil",
31+
"fuga",
32+
"facilis",
33+
"eum",
34+
],
35+
"iusto": [
36+
"saepe",
37+
"inventore",
38+
],
39+
},
40+
op=Operations::GetApisOp(
41+
and_=false,
42+
),
43+
),
44+
)
45+
46+
res = s.apis::get_apis(req)
47+
48+
if ! res.apis.nil?
49+
# handle response
50+
```
51+
<!-- End SDK Example Usage -->
52+
53+
<!-- Start SDK Available Operations -->
54+
## SDK Available Operations
55+
56+
57+
* `validate_api_key` - Validate the current api key.
58+
59+
60+
* `delete_api_endpoint` - Delete an ApiEndpoint.
61+
* `find_api_endpoint` - Find an ApiEndpoint via its displayName.
62+
* `generate_open_api_spec_for_api_endpoint` - Generate an OpenAPI specification for a particular ApiEndpoint.
63+
* `generate_postman_collection_for_api_endpoint` - Generate a Postman collection for a particular ApiEndpoint.
64+
* `get_all_api_endpoints` - Get all Api endpoints for a particular apiID.
65+
* `get_all_for_version_api_endpoints` - Get all ApiEndpoints for a particular apiID and versionID.
66+
* `get_api_endpoint` - Get an ApiEndpoint.
67+
* `upsert_api_endpoint` - Upsert an ApiEndpoint.
68+
69+
70+
* `delete_api` - Delete an Api.
71+
* `generate_open_api_spec` - Generate an OpenAPI specification for a particular Api.
72+
* `generate_postman_collection` - Generate a Postman collection for a particular Api.
73+
* `get_all_api_versions` - Get all Api versions for a particular ApiEndpoint.
74+
* `get_apis` - Get a list of Apis for a given workspace
75+
* `upsert_api` - Upsert an Api
76+
77+
78+
* `get_embed_access_token` - Get an embed access token for the current workspace.
79+
* `get_valid_embed_access_tokens` - Get all valid embed access tokens for the current workspace.
80+
* `revoke_embed_access_token` - Revoke an embed access EmbedToken.
81+
82+
83+
* `delete_version_metadata` - Delete metadata for a particular apiID and versionID.
84+
* `get_version_metadata` - Get all metadata for a particular apiID and versionID.
85+
* `insert_version_metadata` - Insert metadata for a particular apiID and versionID.
86+
87+
88+
* `get_plugins` - Get all plugins for the current workspace.
89+
* `run_plugin` - Run a plugin
90+
* `upsert_plugin` - Upsert a plugin
91+
92+
93+
* `generate_request_postman_collection` - Generate a Postman collection for a particular request.
94+
* `get_request_from_event_log` - Get information about a particular request.
95+
* `query_event_log` - Query the event log to retrieve a list of requests.
96+
97+
98+
* `delete_schema` - Delete a particular schema revision for an Api.
99+
* `download_schema` - Download the latest schema for a particular apiID.
100+
* `download_schema_revision` - Download a particular schema revision for an Api.
101+
* `get_schema` - Get information about the latest schema.
102+
* `get_schema_diff` - Get a diff of two schema revisions for an Api.
103+
* `get_schema_revision` - Get information about a particular schema revision for an Api.
104+
* `get_schemas` - Get information about all schemas associated with a particular apiID.
105+
* `register_schema` - Register a schema.
106+
<!-- End SDK Available Operations -->
107+
108+
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎Rakefile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
require "bundler/gem_tasks"
2+
require "minitest/test_task"
3+
require "rubocop/rake_task"
4+
5+
RuboCop::RakeTask.new
6+
7+
Minitest::TestTask.create
8+
9+
# So far default is working - leaving this here for reference.
10+
11+
#Minitest::TestTask.create(:test) do |t|
12+
# t.libs << "test"
13+
# t.libs << "lib"
14+
# t.warning = false
15+
# t.test_globs = ["test/**/*_test.rb"]
16+
#end
17+
18+
task :default => :test

‎USAGE.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!-- Start SDK Example Usage -->
2+
```ruby
3+
require_relative sdk
4+
5+
s = sdk::SDK.new()
6+
s.config_security(
7+
security=Shared::Security(
8+
api_key="YOUR_API_KEY_HERE",
9+
)
10+
)
11+
12+
req = operations.Operations::GetApisRequest(
13+
query_params=Operations::GetApisQueryParams(
14+
metadata={
15+
"deserunt": [
16+
"nulla",
17+
"id",
18+
"vero",
19+
],
20+
"perspiciatis": [
21+
"nihil",
22+
"fuga",
23+
"facilis",
24+
"eum",
25+
],
26+
"iusto": [
27+
"saepe",
28+
"inventore",
29+
],
30+
},
31+
op=Operations::GetApisOp(
32+
and_=false,
33+
),
34+
),
35+
)
36+
37+
res = s.apis::get_apis(req)
38+
39+
if ! res.apis.nil?
40+
# handle response
41+
```
42+
<!-- End SDK Example Usage -->

‎files.gen‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
lib/sdk/apiendpoints.rb
2+
lib/sdk/apis.rb
3+
lib/sdk/embeds.rb
4+
lib/sdk/metadata.rb
5+
lib/sdk/plugins.rb
6+
lib/sdk/requests.rb
7+
lib/sdk/schemas.rb
8+
lib/sdk/sdk.rb
9+
Gemfile
10+
Rakefile
11+
lib/sdk/utils/metadata_fields.rb
12+
lib/sdk/utils/retries.rb
13+
lib/sdk/utils/utils.rb
14+
openapi.gemspec
15+
lib/sdk/models/operations/deleteapiendpoint.rb
16+
lib/sdk/models/operations/findapiendpoint.rb
17+
lib/sdk/models/operations/generateopenapispecforapiendpoint.rb
18+
lib/sdk/models/operations/generatepostmancollectionforapiendpoint.rb
19+
lib/sdk/models/operations/getallapiendpoints.rb
20+
lib/sdk/models/operations/getallforversionapiendpoints.rb
21+
lib/sdk/models/operations/getapiendpoint.rb
22+
lib/sdk/models/operations/upsertapiendpoint.rb
23+
lib/sdk/models/operations/deleteapi.rb
24+
lib/sdk/models/operations/generateopenapispec.rb
25+
lib/sdk/models/operations/generatepostmancollection.rb
26+
lib/sdk/models/operations/getallapiversions.rb
27+
lib/sdk/models/operations/getapis.rb
28+
lib/sdk/models/operations/upsertapi.rb
29+
lib/sdk/models/operations/getembedaccesstoken.rb
30+
lib/sdk/models/operations/getvalidembedaccesstokens.rb
31+
lib/sdk/models/operations/revokeembedaccesstoken.rb
32+
lib/sdk/models/operations/deleteversionmetadata.rb
33+
lib/sdk/models/operations/getversionmetadata.rb
34+
lib/sdk/models/operations/insertversionmetadata.rb
35+
lib/sdk/models/operations/getplugins.rb
36+
lib/sdk/models/operations/runplugin.rb
37+
lib/sdk/models/operations/upsertplugin.rb
38+
lib/sdk/models/operations/generaterequestpostmancollection.rb
39+
lib/sdk/models/operations/getrequestfromeventlog.rb
40+
lib/sdk/models/operations/queryeventlog.rb
41+
lib/sdk/models/operations/deleteschema.rb
42+
lib/sdk/models/operations/downloadschema.rb
43+
lib/sdk/models/operations/downloadschemarevision.rb
44+
lib/sdk/models/operations/getschema.rb
45+
lib/sdk/models/operations/getschemadiff.rb
46+
lib/sdk/models/operations/getschemarevision.rb
47+
lib/sdk/models/operations/getschemas.rb
48+
lib/sdk/models/operations/registerschema.rb
49+
lib/sdk/models/operations/validateapikey.rb
50+
lib/sdk/models/shared/error.rb
51+
lib/sdk/models/shared/apiendpoint.rb
52+
lib/sdk/models/shared/generateopenapispecdiff.rb
53+
lib/sdk/models/shared/api.rb
54+
lib/sdk/models/shared/embedaccesstokenresponse.rb
55+
lib/sdk/models/shared/filters.rb
56+
lib/sdk/models/shared/filter.rb
57+
lib/sdk/models/shared/embedtoken.rb
58+
lib/sdk/models/shared/versionmetadata.rb
59+
lib/sdk/models/shared/plugin.rb
60+
lib/sdk/models/shared/boundedrequest.rb
61+
lib/sdk/models/shared/requestmetadata.rb
62+
lib/sdk/models/shared/unboundedrequest.rb
63+
lib/sdk/models/shared/schema.rb
64+
lib/sdk/models/shared/schemadiff.rb
65+
lib/sdk/models/shared/security.rb
66+
lib/openapi.rb
67+
USAGE.md

‎gen.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
configVersion: 1.0.0
2+
generation:
3+
telemetryEnabled: false
4+
sdkClassName: SDK
5+
sdkFlattening: true
6+
ruby:
7+
version: 0.0.1
8+
author: Speakeasy
9+
description: Ruby Client SDK Generated by Speakeasy
10+
module: OpenApiSdk
11+
packageName: openapi

‎lib/openapi.rb‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
require_relative 'sdk/utils/retries'
2+
require_relative 'sdk/utils/utils'
3+
require_relative 'sdk/utils/metadata_fields'
4+
require_relative 'sdk/sdk'
5+
require_relative 'sdk/models/shared/error'
6+
require_relative 'sdk/models/shared/apiendpoint'
7+
require_relative 'sdk/models/shared/generateopenapispecdiff'
8+
require_relative 'sdk/models/shared/api'
9+
require_relative 'sdk/models/shared/embedaccesstokenresponse'
10+
require_relative 'sdk/models/shared/filters'
11+
require_relative 'sdk/models/shared/filter'
12+
require_relative 'sdk/models/shared/embedtoken'
13+
require_relative 'sdk/models/shared/versionmetadata'
14+
require_relative 'sdk/models/shared/plugin'
15+
require_relative 'sdk/models/shared/boundedrequest'
16+
require_relative 'sdk/models/shared/requestmetadata'
17+
require_relative 'sdk/models/shared/unboundedrequest'
18+
require_relative 'sdk/models/shared/schema'
19+
require_relative 'sdk/models/shared/schemadiff'
20+
require_relative 'sdk/models/shared/security'
21+
require_relative 'sdk/models/operations/deleteapi'
22+
require_relative 'sdk/models/operations/deleteapiendpoint'
23+
require_relative 'sdk/models/operations/deleteschema'
24+
require_relative 'sdk/models/operations/deleteversionmetadata'
25+
require_relative 'sdk/models/operations/downloadschema'
26+
require_relative 'sdk/models/operations/downloadschemarevision'
27+
require_relative 'sdk/models/operations/findapiendpoint'
28+
require_relative 'sdk/models/operations/generateopenapispec'
29+
require_relative 'sdk/models/operations/generateopenapispecforapiendpoint'
30+
require_relative 'sdk/models/operations/generatepostmancollection'
31+
require_relative 'sdk/models/operations/generatepostmancollectionforapiendpoint'
32+
require_relative 'sdk/models/operations/generaterequestpostmancollection'
33+
require_relative 'sdk/models/operations/getallapiendpoints'
34+
require_relative 'sdk/models/operations/getallapiversions'
35+
require_relative 'sdk/models/operations/getallforversionapiendpoints'
36+
require_relative 'sdk/models/operations/getapiendpoint'
37+
require_relative 'sdk/models/operations/getapis'
38+
require_relative 'sdk/models/operations/getembedaccesstoken'
39+
require_relative 'sdk/models/operations/getplugins'
40+
require_relative 'sdk/models/operations/getrequestfromeventlog'
41+
require_relative 'sdk/models/operations/getschema'
42+
require_relative 'sdk/models/operations/getschemadiff'
43+
require_relative 'sdk/models/operations/getschemarevision'
44+
require_relative 'sdk/models/operations/getschemas'
45+
require_relative 'sdk/models/operations/getvalidembedaccesstokens'
46+
require_relative 'sdk/models/operations/getversionmetadata'
47+
require_relative 'sdk/models/operations/insertversionmetadata'
48+
require_relative 'sdk/models/operations/queryeventlog'
49+
require_relative 'sdk/models/operations/registerschema'
50+
require_relative 'sdk/models/operations/revokeembedaccesstoken'
51+
require_relative 'sdk/models/operations/runplugin'
52+
require_relative 'sdk/models/operations/upsertapi'
53+
require_relative 'sdk/models/operations/upsertapiendpoint'
54+
require_relative 'sdk/models/operations/upsertplugin'
55+
require_relative 'sdk/models/operations/validateapikey'
56+
require_relative 'sdk/apiendpoints'
57+
require_relative 'sdk/apis'
58+
require_relative 'sdk/embeds'
59+
require_relative 'sdk/metadata'
60+
require_relative 'sdk/plugins'
61+
require_relative 'sdk/requests'
62+
require_relative 'sdk/schemas'
63+
64+
module OpenApiSDK
65+
66+
end

0 commit comments

Comments
 (0)