spinnaker-gate-ruby-client 1.0.0

data/docs/User.md

@@ -0,0 +1,18 @@
+# SwaggerClient::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_non_expired** | **BOOLEAN** |  | [optional] 
+**account_non_locked** | **BOOLEAN** |  | [optional] 
+**allowed_accounts** | **Array<String>** |  | [optional] 
+**authorities** | [**Array<GrantedAuthority>**](GrantedAuthority.md) |  | [optional] 
+**credentials_non_expired** | **BOOLEAN** |  | [optional] 
+**email** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**roles** | **Array<String>** |  | [optional] 
+**username** | **String** |  | [optional] 
+
+

data/docs/V2CanaryConfigControllerApi.md

@@ -0,0 +1,259 @@
+# SwaggerClient::V2CanaryConfigControllerApi
+
+All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_canary_config_using_post**](V2CanaryConfigControllerApi.md#create_canary_config_using_post) | **POST** /v2/canaryConfig | Create a canary configuration
+[**delete_canary_config_using_delete**](V2CanaryConfigControllerApi.md#delete_canary_config_using_delete) | **DELETE** /v2/canaryConfig/{id} | Delete a canary configuration
+[**get_canary_config_using_get**](V2CanaryConfigControllerApi.md#get_canary_config_using_get) | **GET** /v2/canaryConfig/{id} | Retrieve a canary configuration by id
+[**get_canary_configs_using_get**](V2CanaryConfigControllerApi.md#get_canary_configs_using_get) | **GET** /v2/canaryConfig | Retrieve a list of canary configurations
+[**update_canary_config_using_put**](V2CanaryConfigControllerApi.md#update_canary_config_using_put) | **PUT** /v2/canaryConfig/{id} | Update a canary configuration
+
+
+# **create_canary_config_using_post**
+> Object create_canary_config_using_post(config, opts)
+
+Create a canary configuration
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryConfigControllerApi.new
+
+config = nil # Object | config
+
+opts = { 
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Create a canary configuration
+  result = api_instance.create_canary_config_using_post(config, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryConfigControllerApi->create_canary_config_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **config** | **Object**| config | 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_canary_config_using_delete**
+> delete_canary_config_using_delete(id, opts)
+
+Delete a canary configuration
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryConfigControllerApi.new
+
+id = 'id_example' # String | id
+
+opts = { 
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Delete a canary configuration
+  api_instance.delete_canary_config_using_delete(id, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryConfigControllerApi->delete_canary_config_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id | 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get_canary_config_using_get**
+> Object get_canary_config_using_get(id, opts)
+
+Retrieve a canary configuration by id
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryConfigControllerApi.new
+
+id = 'id_example' # String | id
+
+opts = { 
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Retrieve a canary configuration by id
+  result = api_instance.get_canary_config_using_get(id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryConfigControllerApi->get_canary_config_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id | 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get_canary_configs_using_get**
+> Array<Object> get_canary_configs_using_get(opts)
+
+Retrieve a list of canary configurations
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryConfigControllerApi.new
+
+opts = { 
+  application: 'application_example', # String | application
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Retrieve a list of canary configurations
+  result = api_instance.get_canary_configs_using_get(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryConfigControllerApi->get_canary_configs_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **application** | **String**| application | [optional] 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_canary_config_using_put**
+> Object update_canary_config_using_put(id, config, opts)
+
+Update a canary configuration
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryConfigControllerApi.new
+
+id = 'id_example' # String | id
+
+config = nil # Object | config
+
+opts = { 
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Update a canary configuration
+  result = api_instance.update_canary_config_using_put(id, config, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryConfigControllerApi->update_canary_config_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id | 
+ **config** | **Object**| config | 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/V2CanaryControllerApi.md

@@ -0,0 +1,356 @@
+# SwaggerClient::V2CanaryControllerApi
+
+All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_canary_result_using_get**](V2CanaryControllerApi.md#get_canary_result_using_get) | **GET** /v2/canaries/canary/{canaryConfigId}/{canaryExecutionId} | Retrieve a canary result
+[**get_canary_results_by_application_using_get**](V2CanaryControllerApi.md#get_canary_results_by_application_using_get) | **GET** /v2/canaries/{application}/executions | Retrieve a list of an application's canary results
+[**get_metric_set_pair_list_using_get**](V2CanaryControllerApi.md#get_metric_set_pair_list_using_get) | **GET** /v2/canaries/metricSetPairList/{metricSetPairListId} | Retrieve a metric set pair list
+[**initiate_canary_using_post**](V2CanaryControllerApi.md#initiate_canary_using_post) | **POST** /v2/canaries/canary/{canaryConfigId} | Start a canary execution
+[**list_credentials_using_get**](V2CanaryControllerApi.md#list_credentials_using_get) | **GET** /v2/canaries/credentials | Retrieve a list of configured Kayenta accounts
+[**list_judges_using_get**](V2CanaryControllerApi.md#list_judges_using_get) | **GET** /v2/canaries/judges | Retrieve a list of all configured canary judges
+[**list_metrics_service_metadata_using_get**](V2CanaryControllerApi.md#list_metrics_service_metadata_using_get) | **GET** /v2/canaries/metadata/metricsService | Retrieve a list of descriptors for use in populating the canary config ui
+
+
+# **get_canary_result_using_get**
+> Object get_canary_result_using_get(canary_config_id, canary_execution_id, opts)
+
+Retrieve a canary result
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+canary_config_id = 'canary_config_id_example' # String | canaryConfigId
+
+canary_execution_id = 'canary_execution_id_example' # String | canaryExecutionId
+
+opts = { 
+  storage_account_name: 'storage_account_name_example' # String | storageAccountName
+}
+
+begin
+  #Retrieve a canary result
+  result = api_instance.get_canary_result_using_get(canary_config_id, canary_execution_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->get_canary_result_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **canary_config_id** | **String**| canaryConfigId | 
+ **canary_execution_id** | **String**| canaryExecutionId | 
+ **storage_account_name** | **String**| storageAccountName | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get_canary_results_by_application_using_get**
+> Array<Object> get_canary_results_by_application_using_get(application, limit, opts)
+
+Retrieve a list of an application's canary results
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+application = 'application_example' # String | application
+
+limit = 56 # Integer | limit
+
+opts = { 
+  statuses: 'statuses_example', # String | Comma-separated list of statuses, e.g.: RUNNING, SUCCEEDED, TERMINAL
+  storage_account_name: 'storage_account_name_example' # String | storageAccountName
+}
+
+begin
+  #Retrieve a list of an application's canary results
+  result = api_instance.get_canary_results_by_application_using_get(application, limit, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->get_canary_results_by_application_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **application** | **String**| application | 
+ **limit** | **Integer**| limit | 
+ **statuses** | **String**| Comma-separated list of statuses, e.g.: RUNNING, SUCCEEDED, TERMINAL | [optional] 
+ **storage_account_name** | **String**| storageAccountName | [optional] 
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get_metric_set_pair_list_using_get**
+> Array<Object> get_metric_set_pair_list_using_get(metric_set_pair_list_id, opts)
+
+Retrieve a metric set pair list
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+metric_set_pair_list_id = 'metric_set_pair_list_id_example' # String | metricSetPairListId
+
+opts = { 
+  storage_account_name: 'storage_account_name_example' # String | storageAccountName
+}
+
+begin
+  #Retrieve a metric set pair list
+  result = api_instance.get_metric_set_pair_list_using_get(metric_set_pair_list_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->get_metric_set_pair_list_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **metric_set_pair_list_id** | **String**| metricSetPairListId | 
+ **storage_account_name** | **String**| storageAccountName | [optional] 
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **initiate_canary_using_post**
+> Object initiate_canary_using_post(canary_config_id, execution_request, opts)
+
+Start a canary execution
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+canary_config_id = 'canary_config_id_example' # String | canaryConfigId
+
+execution_request = nil # Object | executionRequest
+
+opts = { 
+  application: 'application_example', # String | application
+  parent_pipeline_execution_id: 'parent_pipeline_execution_id_example', # String | parentPipelineExecutionId
+  metrics_account_name: 'metrics_account_name_example', # String | metricsAccountName
+  storage_account_name: 'storage_account_name_example', # String | storageAccountName
+  configuration_account_name: 'configuration_account_name_example' # String | configurationAccountName
+}
+
+begin
+  #Start a canary execution
+  result = api_instance.initiate_canary_using_post(canary_config_id, execution_request, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->initiate_canary_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **canary_config_id** | **String**| canaryConfigId | 
+ **execution_request** | **Object**| executionRequest | 
+ **application** | **String**| application | [optional] 
+ **parent_pipeline_execution_id** | **String**| parentPipelineExecutionId | [optional] 
+ **metrics_account_name** | **String**| metricsAccountName | [optional] 
+ **storage_account_name** | **String**| storageAccountName | [optional] 
+ **configuration_account_name** | **String**| configurationAccountName | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list_credentials_using_get**
+> Array<Object> list_credentials_using_get
+
+Retrieve a list of configured Kayenta accounts
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+begin
+  #Retrieve a list of configured Kayenta accounts
+  result = api_instance.list_credentials_using_get
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->list_credentials_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list_judges_using_get**
+> Array<Object> list_judges_using_get
+
+Retrieve a list of all configured canary judges
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+begin
+  #Retrieve a list of all configured canary judges
+  result = api_instance.list_judges_using_get
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->list_judges_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list_metrics_service_metadata_using_get**
+> Array<Object> list_metrics_service_metadata_using_get(opts)
+
+Retrieve a list of descriptors for use in populating the canary config ui
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::V2CanaryControllerApi.new
+
+opts = { 
+  filter: 'filter_example', # String | filter
+  metrics_account_name: 'metrics_account_name_example' # String | metricsAccountName
+}
+
+begin
+  #Retrieve a list of descriptors for use in populating the canary config ui
+  result = api_instance.list_metrics_service_metadata_using_get(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling V2CanaryControllerApi->list_metrics_service_metadata_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filter** | **String**| filter | [optional] 
+ **metrics_account_name** | **String**| metricsAccountName | [optional] 
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+