Class: LaunchDarklyApi::InsightsRepositoriesBetaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/insights_repositories_beta_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsightsRepositoriesBetaApi

Returns a new instance of InsightsRepositoriesBetaApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#associate_repositories_and_projects(insights_repository_project_mappings, opts = {}) ⇒ InsightsRepositoryProjectCollection

Associate repositories with projects Associate repositories with projects

Parameters:

Returns:



27
28
29
30
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 27

def associate_repositories_and_projects(insights_repository_project_mappings, opts = {})
  data, _status_code, _headers = associate_repositories_and_projects_with_http_info(insights_repository_project_mappings, opts)
  data
end

#associate_repositories_and_projects_with_http_info(insights_repository_project_mappings, opts = {}) ⇒ Array<(InsightsRepositoryProjectCollection, Integer, Hash)>

Associate repositories with projects Associate repositories with projects

Parameters:

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 37

def associate_repositories_and_projects_with_http_info(insights_repository_project_mappings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsRepositoriesBetaApi.associate_repositories_and_projects ...'
  end
  # verify the required parameter 'insights_repository_project_mappings' is set
  if @api_client.config.client_side_validation && insights_repository_project_mappings.nil?
    fail ArgumentError, "Missing the required parameter 'insights_repository_project_mappings' when calling InsightsRepositoriesBetaApi.associate_repositories_and_projects"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/repositories/projects'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(insights_repository_project_mappings)

  # return_type
  return_type = opts[:debug_return_type] || 'InsightsRepositoryProjectCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsRepositoriesBetaApi.associate_repositories_and_projects",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InsightsRepositoriesBetaApi#associate_repositories_and_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_repository_project(repository_key, project_key, opts = {}) ⇒ nil

Remove repository project association Remove repository project association

Parameters:

  • repository_key (String) —

    The repository key

  • project_key (String) —

    The project key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 96

def delete_repository_project(repository_key, project_key, opts = {})
  delete_repository_project_with_http_info(repository_key, project_key, opts)
  nil
end

#delete_repository_project_with_http_info(repository_key, project_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove repository project association Remove repository project association

Parameters:

  • repository_key (String) —

    The repository key

  • project_key (String) —

    The project key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 107

def delete_repository_project_with_http_info(repository_key, project_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsRepositoriesBetaApi.delete_repository_project ...'
  end
  # verify the required parameter 'repository_key' is set
  if @api_client.config.client_side_validation && repository_key.nil?
    fail ArgumentError, "Missing the required parameter 'repository_key' when calling InsightsRepositoriesBetaApi.delete_repository_project"
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling InsightsRepositoriesBetaApi.delete_repository_project"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/repositories/{repositoryKey}/projects/{projectKey}'.sub('{' + 'repositoryKey' + '}', CGI.escape(repository_key.to_s)).sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsRepositoriesBetaApi.delete_repository_project",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InsightsRepositoriesBetaApi#delete_repository_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_insights_repositories(opts = {}) ⇒ InsightsRepositoryCollection

List repositories Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the ‘expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is not included in the response.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand properties in response. Options: &#x60;projects&#x60;

Returns:



164
165
166
167
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 164

def get_insights_repositories(opts = {})
  data, _status_code, _headers = get_insights_repositories_with_http_info(opts)
  data
end

#get_insights_repositories_with_http_info(opts = {}) ⇒ Array<(InsightsRepositoryCollection, Integer, Hash)>

List repositories Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the &#x60;expand&#x60; query parameter and include the following: * &#x60;projects&#x60; includes details on all of the LaunchDarkly projects associated with each repository For example, use &#x60;?expand&#x3D;projects&#x60; to include the &#x60;projects&#x60; field in the response. By default, this field is not included in the response.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand properties in response. Options: &#x60;projects&#x60;

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/launchdarkly_api/api/insights_repositories_beta_api.rb', line 174

def get_insights_repositories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsRepositoriesBetaApi.get_insights_repositories ...'
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/repositories'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InsightsRepositoryCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsRepositoriesBetaApi.get_insights_repositories",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InsightsRepositoriesBetaApi#get_insights_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end