Skip to content

chore(api): sync OpenAPI contract #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kong wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore(api): sync OpenAPI contract #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions lib/volcano/generated/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ lib/volcano-generated/api/locks_api.rb
lib/volcano-generated/api/logs_api.rb
lib/volcano-generated/api/o_auth_authentication_api.rb
lib/volcano-generated/api/o_auth_configuration_api.rb
lib/volcano-generated/api/project_access_tokens_api.rb
lib/volcano-generated/api/project_imports_api.rb
lib/volcano-generated/api/projects_api.rb
lib/volcano-generated/api/realtime_api.rb
Expand Down Expand Up @@ -99,6 +100,11 @@ lib/volcano-generated/models/ban_auth_user_request.rb
lib/volcano-generated/models/ban_user_response.rb
lib/volcano-generated/models/batch_function_deploy_failure.rb
lib/volcano-generated/models/batch_function_deploy_response.rb
lib/volcano-generated/models/call_mcp200_response.rb
lib/volcano-generated/models/call_mcp200_response_error.rb
lib/volcano-generated/models/call_mcp200_response_id.rb
lib/volcano-generated/models/call_mcp_request.rb
lib/volcano-generated/models/call_mcp_request_id.rb
lib/volcano-generated/models/call_o_auth_provider_api200_response.rb
lib/volcano-generated/models/call_o_auth_provider_api_request.rb
lib/volcano-generated/models/complete_upload_session_response.rb
Expand All @@ -114,13 +120,15 @@ lib/volcano-generated/models/create_email_template_request.rb
lib/volcano-generated/models/create_frontend_custom_domain_request.rb
lib/volcano-generated/models/create_function_scheduler_request.rb
lib/volcano-generated/models/create_o_auth_config_request.rb
lib/volcano-generated/models/create_project_access_token_request.rb
lib/volcano-generated/models/create_project_request.rb
lib/volcano-generated/models/create_service_key_request.rb
lib/volcano-generated/models/create_storage_bucket_request.rb
lib/volcano-generated/models/create_storage_policy_request.rb
lib/volcano-generated/models/create_upload_session_request.rb
lib/volcano-generated/models/create_upload_session_response.rb
lib/volcano-generated/models/create_variable_request.rb
lib/volcano-generated/models/created_project_access_token.rb
lib/volcano-generated/models/database.rb
lib/volcano-generated/models/database_backup.rb
lib/volcano-generated/models/database_backup_list.rb
Expand Down Expand Up @@ -240,6 +248,7 @@ lib/volcano-generated/models/paginated_frontend_deployments.rb
lib/volcano-generated/models/paginated_frontends.rb
lib/volcano-generated/models/paginated_function_deployments.rb
lib/volcano-generated/models/paginated_functions.rb
lib/volcano-generated/models/paginated_project_access_tokens.rb
lib/volcano-generated/models/paginated_project_custom_domains.rb
lib/volcano-generated/models/paginated_project_deployments.rb
lib/volcano-generated/models/paginated_projects.rb
Expand All @@ -250,6 +259,10 @@ lib/volcano-generated/models/platform_exchange_response.rb
lib/volcano-generated/models/preview_auth_page_request.rb
lib/volcano-generated/models/preview_auth_page_response.rb
lib/volcano-generated/models/project.rb
lib/volcano-generated/models/project_access_token.rb
lib/volcano-generated/models/project_access_token_scope.rb
lib/volcano-generated/models/project_access_token_usage.rb
lib/volcano-generated/models/project_access_token_usage_daily_entry.rb
lib/volcano-generated/models/project_config.rb
lib/volcano-generated/models/project_config_apply_result.rb
lib/volcano-generated/models/project_config_apply_result_entry.rb
Expand Down Expand Up @@ -349,6 +362,7 @@ lib/volcano-generated/models/realtime_config.rb
lib/volcano-generated/models/realtime_plan_limits.rb
lib/volcano-generated/models/realtime_stats.rb
lib/volcano-generated/models/refresh_o_auth_provider_token200_response.rb
lib/volcano-generated/models/replace_frontend_shared_variables_request.rb
lib/volcano-generated/models/replace_shared_variables_request.rb
lib/volcano-generated/models/reset_database_password200_response.rb
lib/volcano-generated/models/resolve_function_response.rb
Expand Down
38 changes: 36 additions & 2 deletions lib/volcano/generated/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,12 @@ require 'volcano-generated'

# Setup authorization
Volcano::Generated.configure do |config|
# Configure Bearer authorization (JWT): UserToken
# Configure Bearer authorization (opaque): UserToken
config.access_token = 'YOUR_BEARER_TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }

# Configure Bearer authorization (opaque): ProjectAccessToken
config.access_token = 'YOUR_BEARER_TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
Expand Down Expand Up @@ -271,6 +276,12 @@ Class | Method | HTTP request | Description
*Volcano::Generated::OAuthConfigurationApi* | [**list_available_o_auth_providers**](docs/OAuthConfigurationApi.md#list_available_o_auth_providers) | **GET** /projects/{id}/oauth/providers | List available OAuth providers
*Volcano::Generated::OAuthConfigurationApi* | [**list_o_auth_configs**](docs/OAuthConfigurationApi.md#list_o_auth_configs) | **GET** /projects/{id}/oauth/configs | List OAuth configurations
*Volcano::Generated::OAuthConfigurationApi* | [**update_o_auth_config**](docs/OAuthConfigurationApi.md#update_o_auth_config) | **PUT** /projects/{id}/oauth/configs/{provider} | Update OAuth configuration
*Volcano::Generated::ProjectAccessTokensApi* | [**create_project_access_token**](docs/ProjectAccessTokensApi.md#create_project_access_token) | **POST** /projects/{id}/access-tokens | Create a project access token
*Volcano::Generated::ProjectAccessTokensApi* | [**get_project_access_token**](docs/ProjectAccessTokensApi.md#get_project_access_token) | **GET** /projects/{id}/access-tokens/{tokenId} | Get a project access token
*Volcano::Generated::ProjectAccessTokensApi* | [**get_project_access_token_usage**](docs/ProjectAccessTokensApi.md#get_project_access_token_usage) | **GET** /projects/{id}/access-tokens/{tokenId}/usage | Per-day request counts for one access token
*Volcano::Generated::ProjectAccessTokensApi* | [**list_project_access_tokens**](docs/ProjectAccessTokensApi.md#list_project_access_tokens) | **GET** /projects/{id}/access-tokens | List a project's access tokens
*Volcano::Generated::ProjectAccessTokensApi* | [**list_project_access_tokens_usage**](docs/ProjectAccessTokensApi.md#list_project_access_tokens_usage) | **GET** /projects/{id}/access-tokens/usage | Per-day request counts for every access token in a project
*Volcano::Generated::ProjectAccessTokensApi* | [**revoke_project_access_token**](docs/ProjectAccessTokensApi.md#revoke_project_access_token) | **DELETE** /projects/{id}/access-tokens/{tokenId} | Revoke a project access token
*Volcano::Generated::ProjectImportsApi* | [**complete_import_connect**](docs/ProjectImportsApi.md#complete_import_connect) | **GET** /imports/{provider}/callback | Complete a project import provider connection
*Volcano::Generated::ProjectImportsApi* | [**delete_import_connection**](docs/ProjectImportsApi.md#delete_import_connection) | **DELETE** /user/imports/connections/{connectionId} | Delete a project import provider connection
*Volcano::Generated::ProjectImportsApi* | [**get_project_import_run**](docs/ProjectImportsApi.md#get_project_import_run) | **GET** /imports/{provider}/runs/{runId} | Get a project import run
Expand Down Expand Up @@ -299,6 +310,7 @@ Class | Method | HTTP request | Description
*Volcano::Generated::ProjectsApi* | [**list_project_deployments**](docs/ProjectsApi.md#list_project_deployments) | **GET** /projects/{id}/deployments | List deployments in a project
*Volcano::Generated::ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /projects | List all projects for authenticated user
*Volcano::Generated::ProjectsApi* | [**query_project_metrics**](docs/ProjectsApi.md#query_project_metrics) | **POST** /projects/{id}/metrics/query | Query project runtime metrics
*Volcano::Generated::ProjectsApi* | [**replace_frontend_shared_variables**](docs/ProjectsApi.md#replace_frontend_shared_variables) | **PUT** /projects/{id}/frontend-shared-variables | Replace frontend shared variable names
*Volcano::Generated::ProjectsApi* | [**replace_shared_variables**](docs/ProjectsApi.md#replace_shared_variables) | **PUT** /projects/{id}/shared-variables | Replace shared variable names
*Volcano::Generated::ProjectsApi* | [**set_project_git_production_branch**](docs/ProjectsApi.md#set_project_git_production_branch) | **PUT** /projects/{id}/git-connection/production-branch | Set the branch a project deploys from
*Volcano::Generated::ProjectsApi* | [**summarize_project_deployments**](docs/ProjectsApi.md#summarize_project_deployments) | **GET** /projects/{id}/deployments/summary | Summarize deployments in a project
Expand Down Expand Up @@ -332,6 +344,11 @@ Class | Method | HTTP request | Description
*Volcano::Generated::StoragePoliciesApi* | [**create_storage_policy**](docs/StoragePoliciesApi.md#create_storage_policy) | **POST** /projects/{id}/storage/buckets/{bucketName}/policies | Create a storage policy
*Volcano::Generated::StoragePoliciesApi* | [**delete_storage_policy**](docs/StoragePoliciesApi.md#delete_storage_policy) | **DELETE** /projects/{id}/storage/buckets/{bucketName}/policies/{policyId} | Delete a storage policy
*Volcano::Generated::StoragePoliciesApi* | [**list_storage_policies**](docs/StoragePoliciesApi.md#list_storage_policies) | **GET** /projects/{id}/storage/buckets/{bucketName}/policies | List storage policies for a bucket
*Volcano::Generated::SystemApi* | [**call_mcp**](docs/SystemApi.md#call_mcp) | **POST** /mcp | Model Context Protocol endpoint
*Volcano::Generated::SystemApi* | [**get_open_api_spec_json**](docs/SystemApi.md#get_open_api_spec_json) | **GET** /openapi.json | Fetch the OpenAPI specification as JSON
*Volcano::Generated::SystemApi* | [**get_open_api_spec_yaml**](docs/SystemApi.md#get_open_api_spec_yaml) | **GET** /openapi.yaml | Fetch the OpenAPI specification as YAML
*Volcano::Generated::SystemApi* | [**head_open_api_spec_json**](docs/SystemApi.md#head_open_api_spec_json) | **HEAD** /openapi.json | Check the JSON OpenAPI specification
*Volcano::Generated::SystemApi* | [**head_open_api_spec_yaml**](docs/SystemApi.md#head_open_api_spec_yaml) | **HEAD** /openapi.yaml | Check the YAML OpenAPI specification
*Volcano::Generated::SystemApi* | [**health_check**](docs/SystemApi.md#health_check) | **GET** /health | Health check endpoint
*Volcano::Generated::VariablesApi* | [**create_variable**](docs/VariablesApi.md#create_variable) | **POST** /projects/{id}/variables | Create or update a variable
*Volcano::Generated::VariablesApi* | [**delete_variable**](docs/VariablesApi.md#delete_variable) | **DELETE** /projects/{id}/variables/{name} | Delete a variable
Expand Down Expand Up @@ -402,6 +419,11 @@ Class | Method | HTTP request | Description
- [Volcano::Generated::BanUserResponse](docs/BanUserResponse.md)
- [Volcano::Generated::BatchFunctionDeployFailure](docs/BatchFunctionDeployFailure.md)
- [Volcano::Generated::BatchFunctionDeployResponse](docs/BatchFunctionDeployResponse.md)
- [Volcano::Generated::CallMCP200Response](docs/CallMCP200Response.md)
- [Volcano::Generated::CallMCP200ResponseError](docs/CallMCP200ResponseError.md)
- [Volcano::Generated::CallMCP200ResponseId](docs/CallMCP200ResponseId.md)
- [Volcano::Generated::CallMCPRequest](docs/CallMCPRequest.md)
- [Volcano::Generated::CallMCPRequestId](docs/CallMCPRequestId.md)
- [Volcano::Generated::CallOAuthProviderAPI200Response](docs/CallOAuthProviderAPI200Response.md)
- [Volcano::Generated::CallOAuthProviderAPIRequest](docs/CallOAuthProviderAPIRequest.md)
- [Volcano::Generated::CompleteUploadSessionResponse](docs/CompleteUploadSessionResponse.md)
Expand All @@ -417,13 +439,15 @@ Class | Method | HTTP request | Description
- [Volcano::Generated::CreateFrontendCustomDomainRequest](docs/CreateFrontendCustomDomainRequest.md)
- [Volcano::Generated::CreateFunctionSchedulerRequest](docs/CreateFunctionSchedulerRequest.md)
- [Volcano::Generated::CreateOAuthConfigRequest](docs/CreateOAuthConfigRequest.md)
- [Volcano::Generated::CreateProjectAccessTokenRequest](docs/CreateProjectAccessTokenRequest.md)
- [Volcano::Generated::CreateProjectRequest](docs/CreateProjectRequest.md)
- [Volcano::Generated::CreateServiceKeyRequest](docs/CreateServiceKeyRequest.md)
- [Volcano::Generated::CreateStorageBucketRequest](docs/CreateStorageBucketRequest.md)
- [Volcano::Generated::CreateStoragePolicyRequest](docs/CreateStoragePolicyRequest.md)
- [Volcano::Generated::CreateUploadSessionRequest](docs/CreateUploadSessionRequest.md)
- [Volcano::Generated::CreateUploadSessionResponse](docs/CreateUploadSessionResponse.md)
- [Volcano::Generated::CreateVariableRequest](docs/CreateVariableRequest.md)
- [Volcano::Generated::CreatedProjectAccessToken](docs/CreatedProjectAccessToken.md)
- [Volcano::Generated::Database](docs/Database.md)
- [Volcano::Generated::DatabaseBackup](docs/DatabaseBackup.md)
- [Volcano::Generated::DatabaseBackupList](docs/DatabaseBackupList.md)
Expand Down Expand Up @@ -543,6 +567,7 @@ Class | Method | HTTP request | Description
- [Volcano::Generated::PaginatedFrontends](docs/PaginatedFrontends.md)
- [Volcano::Generated::PaginatedFunctionDeployments](docs/PaginatedFunctionDeployments.md)
- [Volcano::Generated::PaginatedFunctions](docs/PaginatedFunctions.md)
- [Volcano::Generated::PaginatedProjectAccessTokens](docs/PaginatedProjectAccessTokens.md)
- [Volcano::Generated::PaginatedProjectCustomDomains](docs/PaginatedProjectCustomDomains.md)
- [Volcano::Generated::PaginatedProjectDeployments](docs/PaginatedProjectDeployments.md)
- [Volcano::Generated::PaginatedProjects](docs/PaginatedProjects.md)
Expand All @@ -553,6 +578,10 @@ Class | Method | HTTP request | Description
- [Volcano::Generated::PreviewAuthPageRequest](docs/PreviewAuthPageRequest.md)
- [Volcano::Generated::PreviewAuthPageResponse](docs/PreviewAuthPageResponse.md)
- [Volcano::Generated::Project](docs/Project.md)
- [Volcano::Generated::ProjectAccessToken](docs/ProjectAccessToken.md)
- [Volcano::Generated::ProjectAccessTokenScope](docs/ProjectAccessTokenScope.md)
- [Volcano::Generated::ProjectAccessTokenUsage](docs/ProjectAccessTokenUsage.md)
- [Volcano::Generated::ProjectAccessTokenUsageDailyEntry](docs/ProjectAccessTokenUsageDailyEntry.md)
- [Volcano::Generated::ProjectConfig](docs/ProjectConfig.md)
- [Volcano::Generated::ProjectConfigApplyResult](docs/ProjectConfigApplyResult.md)
- [Volcano::Generated::ProjectConfigApplyResultEntry](docs/ProjectConfigApplyResultEntry.md)
Expand Down Expand Up @@ -652,6 +681,7 @@ Class | Method | HTTP request | Description
- [Volcano::Generated::RealtimePlanLimits](docs/RealtimePlanLimits.md)
- [Volcano::Generated::RealtimeStats](docs/RealtimeStats.md)
- [Volcano::Generated::RefreshOAuthProviderToken200Response](docs/RefreshOAuthProviderToken200Response.md)
- [Volcano::Generated::ReplaceFrontendSharedVariablesRequest](docs/ReplaceFrontendSharedVariablesRequest.md)
- [Volcano::Generated::ReplaceSharedVariablesRequest](docs/ReplaceSharedVariablesRequest.md)
- [Volcano::Generated::ResetDatabasePassword200Response](docs/ResetDatabasePassword200Response.md)
- [Volcano::Generated::ResolveFunctionResponse](docs/ResolveFunctionResponse.md)
Expand Down Expand Up @@ -711,5 +741,9 @@ Authentication schemes defined for the API:

### UserToken

- **Type**: Bearer authentication (JWT)
- **Type**: Bearer authentication (opaque)

### ProjectAccessToken

- **Type**: Bearer authentication (opaque)

Loading
Loading