Skip to content

Latest commit

 

History

History
319 lines (232 loc) · 13.5 KB

ApprovalsBetaApi.md

File metadata and controls

319 lines (232 loc) · 13.5 KB

LaunchDarklyApi::ApprovalsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
get_approval_request_settings GET /api/v2/approval-requests/projects/{projectKey}/settings Get approval request settings
patch_approval_request PATCH /api/v2/approval-requests/{id} Update approval request
patch_approval_request_settings PATCH /api/v2/approval-requests/projects/{projectKey}/settings Update approval request settings
patch_flag_config_approval_request PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Update flag approval request

get_approval_request_settings

<Hash<String, ApprovalRequestSettingWithEnvs>> get_approval_request_settings(ld_api_version, project_key, opts)

Get approval request settings

Get the approval request settings for the given project, optionally filtered by environment and resource kind.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApprovalsBetaApi.new
ld_api_version = 'beta' # String | Version of the endpoint.
project_key = 'default' # String | 
opts = {
  environment_key: 'environment_key_example', # String | An environment key filter to apply to the approval request settings.
  resource_kind: 'resource_kind_example', # String | A resource kind filter to apply to the approval request settings.
  expand: 'default,strict' # String | A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'.
}

begin
  # Get approval request settings
  result = api_instance.get_approval_request_settings(ld_api_version, project_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->get_approval_request_settings: #{e}"
end

Using the get_approval_request_settings_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Hash<String, ApprovalRequestSettingWithEnvs>>, Integer, Hash)> get_approval_request_settings_with_http_info(ld_api_version, project_key, opts)

begin
  # Get approval request settings
  data, status_code, headers = api_instance.get_approval_request_settings_with_http_info(ld_api_version, project_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Hash<String, ApprovalRequestSettingWithEnvs>>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->get_approval_request_settings_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ld_api_version String Version of the endpoint.
project_key String
environment_key String An environment key filter to apply to the approval request settings. [optional]
resource_kind String A resource kind filter to apply to the approval request settings. [optional]
expand String A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'. [optional]

Return type

Hash<String, ApprovalRequestSettingWithEnvs>

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patch_approval_request

patch_approval_request(id, approval_request_patch_input)

Update approval request

Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with any approval requests. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. ### Instructions Semantic patch requests support the following kind instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of notifyMemberIds and notifyTeamKeys. ##### Parameters - notifyMemberIds: (Optional) List of member IDs. - notifyTeamKeys: (Optional) List of team keys. Here's an example: json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } #### updateDescription Updates the description (title) of the approval request. ##### Parameters - value: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters. Here's an example: json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated approval request title\" }] }

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApprovalsBetaApi.new
id = 'id_example' # String | The approval ID
approval_request_patch_input = LaunchDarklyApi::ApprovalRequestPatchInput.new({instructions: [{ key: 3.56}]}) # ApprovalRequestPatchInput | 

begin
  # Update approval request
  result = api_instance.patch_approval_request(id, approval_request_patch_input)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_approval_request: #{e}"
end

Using the patch_approval_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_approval_request_with_http_info(id, approval_request_patch_input)

begin
  # Update approval request
  data, status_code, headers = api_instance.patch_approval_request_with_http_info(id, approval_request_patch_input)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlagConfigApprovalRequestResponse>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_approval_request_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String The approval ID
approval_request_patch_input ApprovalRequestPatchInput

Return type

FlagConfigApprovalRequestResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

patch_approval_request_settings

<Hash<String, ApprovalRequestSettingWithEnvs>> patch_approval_request_settings(ld_api_version, project_key, opts)

Update approval request settings

Perform a partial update to approval request settings

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApprovalsBetaApi.new
ld_api_version = 'beta' # String | Version of the endpoint.
project_key = 'default' # String | 
opts = {
  approval_request_settings_patch: LaunchDarklyApi::ApprovalRequestSettingsPatch.new({environment_key: 'environment_key_example', resource_kind: 'resource_kind_example'}) # ApprovalRequestSettingsPatch | Approval request settings to update
}

begin
  # Update approval request settings
  result = api_instance.patch_approval_request_settings(ld_api_version, project_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_approval_request_settings: #{e}"
end

Using the patch_approval_request_settings_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Hash<String, ApprovalRequestSettingWithEnvs>>, Integer, Hash)> patch_approval_request_settings_with_http_info(ld_api_version, project_key, opts)

begin
  # Update approval request settings
  data, status_code, headers = api_instance.patch_approval_request_settings_with_http_info(ld_api_version, project_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Hash<String, ApprovalRequestSettingWithEnvs>>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_approval_request_settings_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ld_api_version String Version of the endpoint.
project_key String
approval_request_settings_patch ApprovalRequestSettingsPatch Approval request settings to update [optional]

Return type

Hash<String, ApprovalRequestSettingWithEnvs>

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

patch_flag_config_approval_request

patch_flag_config_approval_request(project_key, feature_flag_key, environment_key, id)

Update flag approval request

Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. ### Instructions Semantic patch requests support the following kind instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of notifyMemberIds and notifyTeamKeys. ##### Parameters - notifyMemberIds: (Optional) List of member IDs. - notifyTeamKeys: (Optional) List of team keys. #### updateDescription Updates the description (title) of the approval request. ##### Parameters - value: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApprovalsBetaApi.new
project_key = 'project_key_example' # String | The project key
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
environment_key = 'environment_key_example' # String | The environment key
id = 'id_example' # String | The approval ID

begin
  # Update flag approval request
  result = api_instance.patch_flag_config_approval_request(project_key, feature_flag_key, environment_key, id)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_flag_config_approval_request: #{e}"
end

Using the patch_flag_config_approval_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_flag_config_approval_request_with_http_info(project_key, feature_flag_key, environment_key, id)

begin
  # Update flag approval request
  data, status_code, headers = api_instance.patch_flag_config_approval_request_with_http_info(project_key, feature_flag_key, environment_key, id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlagConfigApprovalRequestResponse>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApprovalsBetaApi->patch_flag_config_approval_request_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
feature_flag_key String The feature flag key
environment_key String The environment key
id String The approval ID

Return type

FlagConfigApprovalRequestResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json