Class: Forgejo::IssueApi

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/api/issue_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IssueApi

Returns a new instance of IssueApi.



19
20
21
# File 'lib/forgejo/api/issue_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/forgejo/api/issue_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#issue_add_label(owner, repo, index, opts = {}) ⇒ Array<Label>

Add a label to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
# File 'lib/forgejo/api/issue_api.rb', line 29

def issue_add_label(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_add_label_with_http_info(owner, repo, index, opts)
  data
end

#issue_add_label_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

Add a label to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<Label>, Integer, Hash)>)

    Array<Label> data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/forgejo/api/issue_api.rb', line 41

def issue_add_label_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_add_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_add_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_add_label"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_add_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Label>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_add_label",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_add_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_add_subscription(owner, repo, index, user, opts = {}) ⇒ nil

Subscribe user to issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • user (String)

    user to subscribe

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

    the optional parameters

Returns:

  • (nil)


109
110
111
112
# File 'lib/forgejo/api/issue_api.rb', line 109

def issue_add_subscription(owner, repo, index, user, opts = {})
  issue_add_subscription_with_http_info(owner, repo, index, user, opts)
  nil
end

#issue_add_subscription_with_http_info(owner, repo, index, user, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Subscribe user to issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • user (String)

    user to subscribe

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/forgejo/api/issue_api.rb', line 121

def issue_add_subscription_with_http_info(owner, repo, index, user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_add_subscription ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_add_subscription"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_add_subscription"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_add_subscription"
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling IssueApi.issue_add_subscription"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'user' + '}', CGI.escape(user.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_add_subscription",
    :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: IssueApi#issue_add_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_add_time(owner, repo, index, opts = {}) ⇒ TrackedTime

Add tracked time to a issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



186
187
188
189
# File 'lib/forgejo/api/issue_api.rb', line 186

def issue_add_time(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_add_time_with_http_info(owner, repo, index, opts)
  data
end

#issue_add_time_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(TrackedTime, Integer, Hash)>

Add tracked time to a issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TrackedTime, Integer, Hash)>)

    TrackedTime data, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/forgejo/api/issue_api.rb', line 198

def issue_add_time_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_add_time ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_add_time"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_add_time"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_add_time"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/times'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_add_time",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_add_time\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_check_subscription(owner, repo, index, opts = {}) ⇒ WatchInfo

Check if user is subscribed to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:



265
266
267
268
# File 'lib/forgejo/api/issue_api.rb', line 265

def issue_check_subscription(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_check_subscription_with_http_info(owner, repo, index, opts)
  data
end

#issue_check_subscription_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(WatchInfo, Integer, Hash)>

Check if user is subscribed to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:

  • (Array<(WatchInfo, Integer, Hash)>)

    WatchInfo data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/forgejo/api/issue_api.rb', line 276

def issue_check_subscription_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_check_subscription ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_check_subscription"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_check_subscription"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_check_subscription"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/subscriptions/check'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_check_subscription",
    :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: IssueApi#issue_check_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_clear_labels(owner, repo, index, opts = {}) ⇒ nil

Remove all labels from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


339
340
341
342
# File 'lib/forgejo/api/issue_api.rb', line 339

def issue_clear_labels(owner, repo, index, opts = {})
  issue_clear_labels_with_http_info(owner, repo, index, opts)
  nil
end

#issue_clear_labels_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove all labels from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'lib/forgejo/api/issue_api.rb', line 351

def issue_clear_labels_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_clear_labels ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_clear_labels"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_clear_labels"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_clear_labels"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_clear_labels",
    :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: IssueApi#issue_clear_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_comment(owner, repo, index, opts = {}) ⇒ Comment

Add a comment to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



417
418
419
420
# File 'lib/forgejo/api/issue_api.rb', line 417

def issue_create_comment(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_create_comment_with_http_info(owner, repo, index, opts)
  data
end

#issue_create_comment_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

Add a comment to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Comment, Integer, Hash)>)

    Comment data, response status code and response headers



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'lib/forgejo/api/issue_api.rb', line 429

def issue_create_comment_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_comment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_comment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_comment"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_create_comment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/comments'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_comment",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_issue(owner, repo, opts = {}) ⇒ Issue

Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:



496
497
498
499
# File 'lib/forgejo/api/issue_api.rb', line 496

def issue_create_issue(owner, repo, opts = {})
  data, _status_code, _headers = issue_create_issue_with_http_info(owner, repo, opts)
  data
end

#issue_create_issue_attachment(owner, repo, index, attachment, opts = {}) ⇒ Attachment

Create an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment (File)

    attachment to upload

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    name of the attachment

  • :updated_at (Time)

    time of the attachment&#39;s creation. This is a timestamp in RFC 3339 format

Returns:



573
574
575
576
# File 'lib/forgejo/api/issue_api.rb', line 573

def issue_create_issue_attachment(owner, repo, index, attachment, opts = {})
  data, _status_code, _headers = issue_create_issue_attachment_with_http_info(owner, repo, index, attachment, opts)
  data
end

#issue_create_issue_attachment_with_http_info(owner, repo, index, attachment, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Create an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment (File)

    attachment to upload

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    name of the attachment

  • :updated_at (Time)

    time of the attachment&#39;s creation. This is a timestamp in RFC 3339 format

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
# File 'lib/forgejo/api/issue_api.rb', line 587

def issue_create_issue_attachment_with_http_info(owner, repo, index, attachment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_issue_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_issue_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_issue_attachment"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_create_issue_attachment"
  end
  # verify the required parameter 'attachment' is set
  if @api_client.config.client_side_validation && attachment.nil?
    fail ArgumentError, "Missing the required parameter 'attachment' when calling IssueApi.issue_create_issue_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/assets'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_issue_attachment",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_issue_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_issue_blocking(owner, repo, index, opts = {}) ⇒ Issue

Block the issue given in the body by the issue in path

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



662
663
664
665
# File 'lib/forgejo/api/issue_api.rb', line 662

def issue_create_issue_blocking(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_create_issue_blocking_with_http_info(owner, repo, index, opts)
  data
end

#issue_create_issue_blocking_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Block the issue given in the body by the issue in path

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
# File 'lib/forgejo/api/issue_api.rb', line 674

def issue_create_issue_blocking_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_issue_blocking ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_issue_blocking"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_issue_blocking"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_create_issue_blocking"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/blocks'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_issue_blocking",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_issue_blocking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_issue_comment_attachment(owner, repo, id, attachment, opts = {}) ⇒ Attachment

Create a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment (File)

    attachment to upload

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    name of the attachment

  • :updated_at (Time)

    time of the attachment&#39;s creation. This is a timestamp in RFC 3339 format

Returns:



744
745
746
747
# File 'lib/forgejo/api/issue_api.rb', line 744

def issue_create_issue_comment_attachment(owner, repo, id, attachment, opts = {})
  data, _status_code, _headers = issue_create_issue_comment_attachment_with_http_info(owner, repo, id, attachment, opts)
  data
end

#issue_create_issue_comment_attachment_with_http_info(owner, repo, id, attachment, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Create a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment (File)

    attachment to upload

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    name of the attachment

  • :updated_at (Time)

    time of the attachment&#39;s creation. This is a timestamp in RFC 3339 format

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
# File 'lib/forgejo/api/issue_api.rb', line 758

def issue_create_issue_comment_attachment_with_http_info(owner, repo, id, attachment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_issue_comment_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_issue_comment_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_issue_comment_attachment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_create_issue_comment_attachment"
  end
  # verify the required parameter 'attachment' is set
  if @api_client.config.client_side_validation && attachment.nil?
    fail ArgumentError, "Missing the required parameter 'attachment' when calling IssueApi.issue_create_issue_comment_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/assets'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_issue_comment_attachment",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_issue_comment_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_issue_dependencies(owner, repo, index, opts = {}) ⇒ Issue

Make the issue in the url depend on the issue in the form.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



833
834
835
836
# File 'lib/forgejo/api/issue_api.rb', line 833

def issue_create_issue_dependencies(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_create_issue_dependencies_with_http_info(owner, repo, index, opts)
  data
end

#issue_create_issue_dependencies_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Make the issue in the url depend on the issue in the form.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
# File 'lib/forgejo/api/issue_api.rb', line 845

def issue_create_issue_dependencies_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_issue_dependencies ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_issue_dependencies"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_issue_dependencies"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_create_issue_dependencies"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/dependencies'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_issue_dependencies",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_issue_dependencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_issue_with_http_info(owner, repo, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
# File 'lib/forgejo/api/issue_api.rb', line 507

def issue_create_issue_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_issue ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_issue"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_issue"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_issue",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_label(owner, repo, opts = {}) ⇒ Label

Create a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:



912
913
914
915
# File 'lib/forgejo/api/issue_api.rb', line 912

def issue_create_label(owner, repo, opts = {})
  data, _status_code, _headers = issue_create_label_with_http_info(owner, repo, opts)
  data
end

#issue_create_label_with_http_info(owner, repo, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Create a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Label, Integer, Hash)>)

    Label data, response status code and response headers



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
# File 'lib/forgejo/api/issue_api.rb', line 923

def issue_create_label_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_label",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_create_milestone(owner, repo, opts = {}) ⇒ Milestone

Create a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:



986
987
988
989
# File 'lib/forgejo/api/issue_api.rb', line 986

def issue_create_milestone(owner, repo, opts = {})
  data, _status_code, _headers = issue_create_milestone_with_http_info(owner, repo, opts)
  data
end

#issue_create_milestone_with_http_info(owner, repo, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Create a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Milestone, Integer, Hash)>)

    Milestone data, response status code and response headers



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'lib/forgejo/api/issue_api.rb', line 997

def issue_create_milestone_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_create_milestone ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_create_milestone"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_create_milestone"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/milestones'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_create_milestone",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_create_milestone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete(owner, repo, index, opts = {}) ⇒ nil

Delete an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to delete

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

    the optional parameters

Returns:

  • (nil)


1060
1061
1062
1063
# File 'lib/forgejo/api/issue_api.rb', line 1060

def issue_delete(owner, repo, index, opts = {})
  issue_delete_with_http_info(owner, repo, index, opts)
  nil
end

#issue_delete_comment(owner, repo, id, opts = {}) ⇒ nil

Delete a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of comment to delete

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

    the optional parameters

Returns:

  • (nil)


1131
1132
1133
1134
# File 'lib/forgejo/api/issue_api.rb', line 1131

def issue_delete_comment(owner, repo, id, opts = {})
  issue_delete_comment_with_http_info(owner, repo, id, opts)
  nil
end

#issue_delete_comment_deprecated(owner, repo, index, id, opts = {}) ⇒ nil

Delete a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    this parameter is ignored

  • id (Integer)

    id of comment to delete

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

    the optional parameters

Returns:

  • (nil)


1203
1204
1205
1206
# File 'lib/forgejo/api/issue_api.rb', line 1203

def issue_delete_comment_deprecated(owner, repo, index, id, opts = {})
  issue_delete_comment_deprecated_with_http_info(owner, repo, index, id, opts)
  nil
end

#issue_delete_comment_deprecated_with_http_info(owner, repo, index, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    this parameter is ignored

  • id (Integer)

    id of comment to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
# File 'lib/forgejo/api/issue_api.rb', line 1215

def issue_delete_comment_deprecated_with_http_info(owner, repo, index, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_comment_deprecated ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_comment_deprecated"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_comment_deprecated"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_comment_deprecated"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_comment_deprecated"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/comments/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_comment_deprecated",
    :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: IssueApi#issue_delete_comment_deprecated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_comment_reaction(owner, repo, id, opts = {}) ⇒ nil

Remove a reaction from a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


1280
1281
1282
1283
# File 'lib/forgejo/api/issue_api.rb', line 1280

def issue_delete_comment_reaction(owner, repo, id, opts = {})
  issue_delete_comment_reaction_with_http_info(owner, repo, id, opts)
  nil
end

#issue_delete_comment_reaction_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a reaction from a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
# File 'lib/forgejo/api/issue_api.rb', line 1292

def issue_delete_comment_reaction_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_comment_reaction ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_comment_reaction"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_comment_reaction"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_comment_reaction"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(opts[:'content'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_comment_reaction",
    :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: IssueApi#issue_delete_comment_reaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_comment_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of comment to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'lib/forgejo/api/issue_api.rb', line 1142

def issue_delete_comment_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_comment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_comment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_comment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_comment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_comment",
    :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: IssueApi#issue_delete_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_issue_attachment(owner, repo, index, attachment_id, opts = {}) ⇒ nil

Delete an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to delete

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

    the optional parameters

Returns:

  • (nil)


1358
1359
1360
1361
# File 'lib/forgejo/api/issue_api.rb', line 1358

def issue_delete_issue_attachment(owner, repo, index, attachment_id, opts = {})
  issue_delete_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts)
  nil
end

#issue_delete_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
# File 'lib/forgejo/api/issue_api.rb', line 1370

def issue_delete_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_issue_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_issue_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_issue_attachment"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_issue_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_delete_issue_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_issue_attachment",
    :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: IssueApi#issue_delete_issue_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_issue_comment_attachment(owner, repo, id, attachment_id, opts = {}) ⇒ nil

Delete a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to delete

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

    the optional parameters

Returns:

  • (nil)


1435
1436
1437
1438
# File 'lib/forgejo/api/issue_api.rb', line 1435

def issue_delete_issue_comment_attachment(owner, repo, id, attachment_id, opts = {})
  issue_delete_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts)
  nil
end

#issue_delete_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
# File 'lib/forgejo/api/issue_api.rb', line 1447

def issue_delete_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_issue_comment_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_issue_comment_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_issue_comment_attachment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_issue_comment_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_delete_issue_comment_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_issue_comment_attachment",
    :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: IssueApi#issue_delete_issue_comment_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_issue_reaction(owner, repo, index, opts = {}) ⇒ nil

Remove a reaction from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


1512
1513
1514
1515
# File 'lib/forgejo/api/issue_api.rb', line 1512

def issue_delete_issue_reaction(owner, repo, index, opts = {})
  issue_delete_issue_reaction_with_http_info(owner, repo, index, opts)
  nil
end

#issue_delete_issue_reaction_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a reaction from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
# File 'lib/forgejo/api/issue_api.rb', line 1524

def issue_delete_issue_reaction_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_issue_reaction ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_issue_reaction"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_issue_reaction"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_issue_reaction"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(opts[:'content'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_issue_reaction",
    :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: IssueApi#issue_delete_issue_reaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_label(owner, repo, id, opts = {}) ⇒ nil

Delete a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to delete

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

    the optional parameters

Returns:

  • (nil)


1589
1590
1591
1592
# File 'lib/forgejo/api/issue_api.rb', line 1589

def issue_delete_label(owner, repo, id, opts = {})
  issue_delete_label_with_http_info(owner, repo, id, opts)
  nil
end

#issue_delete_label_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'lib/forgejo/api/issue_api.rb', line 1600

def issue_delete_label_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_label"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/labels/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_label",
    :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: IssueApi#issue_delete_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_milestone(owner, repo, id, opts = {}) ⇒ nil

Delete a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to delete, identified by ID and if not available by name

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

    the optional parameters

Returns:

  • (nil)


1660
1661
1662
1663
# File 'lib/forgejo/api/issue_api.rb', line 1660

def issue_delete_milestone(owner, repo, id, opts = {})
  issue_delete_milestone_with_http_info(owner, repo, id, opts)
  nil
end

#issue_delete_milestone_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to delete, identified by ID and if not available by name

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
# File 'lib/forgejo/api/issue_api.rb', line 1671

def issue_delete_milestone_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_milestone ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_milestone"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_milestone"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_milestone"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/milestones/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_milestone",
    :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: IssueApi#issue_delete_milestone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_stop_watch(owner, repo, index, opts = {}) ⇒ nil

Delete an issue’s existing stopwatch.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to stop the stopwatch on

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

    the optional parameters

Returns:

  • (nil)


1731
1732
1733
1734
# File 'lib/forgejo/api/issue_api.rb', line 1731

def issue_delete_stop_watch(owner, repo, index, opts = {})
  issue_delete_stop_watch_with_http_info(owner, repo, index, opts)
  nil
end

#issue_delete_stop_watch_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an issue&#39;s existing stopwatch.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to stop the stopwatch on

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
# File 'lib/forgejo/api/issue_api.rb', line 1742

def issue_delete_stop_watch_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_stop_watch ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_stop_watch"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_stop_watch"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_stop_watch"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/stopwatch/delete'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_stop_watch",
    :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: IssueApi#issue_delete_stop_watch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_subscription(owner, repo, index, user, opts = {}) ⇒ nil

Unsubscribe user from issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • user (String)

    user witch unsubscribe

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

    the optional parameters

Returns:

  • (nil)


1803
1804
1805
1806
# File 'lib/forgejo/api/issue_api.rb', line 1803

def issue_delete_subscription(owner, repo, index, user, opts = {})
  issue_delete_subscription_with_http_info(owner, repo, index, user, opts)
  nil
end

#issue_delete_subscription_with_http_info(owner, repo, index, user, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unsubscribe user from issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • user (String)

    user witch unsubscribe

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
# File 'lib/forgejo/api/issue_api.rb', line 1815

def issue_delete_subscription_with_http_info(owner, repo, index, user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_subscription ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_subscription"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_subscription"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_subscription"
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling IssueApi.issue_delete_subscription"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'user' + '}', CGI.escape(user.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_subscription",
    :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: IssueApi#issue_delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_time(owner, repo, index, id, opts = {}) ⇒ nil

Delete specific tracked time

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • id (Integer)

    id of time to delete

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

    the optional parameters

Returns:

  • (nil)


1880
1881
1882
1883
# File 'lib/forgejo/api/issue_api.rb', line 1880

def issue_delete_time(owner, repo, index, id, opts = {})
  issue_delete_time_with_http_info(owner, repo, index, id, opts)
  nil
end

#issue_delete_time_with_http_info(owner, repo, index, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete specific tracked time

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • id (Integer)

    id of time to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
# File 'lib/forgejo/api/issue_api.rb', line 1892

def issue_delete_time_with_http_info(owner, repo, index, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete_time ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete_time"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete_time"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete_time"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_delete_time"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/times/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete_time",
    :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: IssueApi#issue_delete_time\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_delete_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'lib/forgejo/api/issue_api.rb', line 1071

def issue_delete_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_delete ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_delete"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_delete"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_delete"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_delete",
    :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: IssueApi#issue_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_comment(owner, repo, id, opts = {}) ⇒ Comment

Edit a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:



1957
1958
1959
1960
# File 'lib/forgejo/api/issue_api.rb', line 1957

def issue_edit_comment(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_edit_comment_with_http_info(owner, repo, id, opts)
  data
end

#issue_edit_comment_deprecated(owner, repo, index, id, opts = {}) ⇒ Comment

Edit a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    this parameter is ignored

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:



2038
2039
2040
2041
# File 'lib/forgejo/api/issue_api.rb', line 2038

def issue_edit_comment_deprecated(owner, repo, index, id, opts = {})
  data, _status_code, _headers = issue_edit_comment_deprecated_with_http_info(owner, repo, index, id, opts)
  data
end

#issue_edit_comment_deprecated_with_http_info(owner, repo, index, id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

Edit a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    this parameter is ignored

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Comment, Integer, Hash)>)

    Comment data, response status code and response headers



2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
# File 'lib/forgejo/api/issue_api.rb', line 2051

def issue_edit_comment_deprecated_with_http_info(owner, repo, index, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_comment_deprecated ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_comment_deprecated"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_comment_deprecated"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_edit_comment_deprecated"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_edit_comment_deprecated"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/comments/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_comment_deprecated",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_comment_deprecated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_comment_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

Edit a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Comment, Integer, Hash)>)

    Comment data, response status code and response headers



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
# File 'lib/forgejo/api/issue_api.rb', line 1969

def issue_edit_comment_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_comment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_comment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_comment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_edit_comment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_comment",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_issue(owner, repo, index, opts = {}) ⇒ Issue

Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to edit

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

    the optional parameters

Options Hash (opts):

Returns:



2123
2124
2125
2126
# File 'lib/forgejo/api/issue_api.rb', line 2123

def issue_edit_issue(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_edit_issue_with_http_info(owner, repo, index, opts)
  data
end

#issue_edit_issue_attachment(owner, repo, index, attachment_id, opts = {}) ⇒ Attachment

Edit an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to edit

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

    the optional parameters

Options Hash (opts):

Returns:



2204
2205
2206
2207
# File 'lib/forgejo/api/issue_api.rb', line 2204

def issue_edit_issue_attachment(owner, repo, index, attachment_id, opts = {})
  data, _status_code, _headers = issue_edit_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts)
  data
end

#issue_edit_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Edit an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
# File 'lib/forgejo/api/issue_api.rb', line 2217

def issue_edit_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_issue_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_issue_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_issue_attachment"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_edit_issue_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_edit_issue_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_issue_attachment",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_issue_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_issue_comment_attachment(owner, repo, id, attachment_id, opts = {}) ⇒ Attachment

Edit a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to edit

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

    the optional parameters

Options Hash (opts):

Returns:



2290
2291
2292
2293
# File 'lib/forgejo/api/issue_api.rb', line 2290

def issue_edit_issue_comment_attachment(owner, repo, id, attachment_id, opts = {})
  data, _status_code, _headers = issue_edit_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts)
  data
end

#issue_edit_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Edit a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
# File 'lib/forgejo/api/issue_api.rb', line 2303

def issue_edit_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_issue_comment_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_issue_comment_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_issue_comment_attachment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_edit_issue_comment_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_edit_issue_comment_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_issue_comment_attachment",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_issue_comment_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_issue_deadline(owner, repo, index, opts = {}) ⇒ IssueDeadline

Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to create or update a deadline on

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

    the optional parameters

Options Hash (opts):

Returns:



2375
2376
2377
2378
# File 'lib/forgejo/api/issue_api.rb', line 2375

def issue_edit_issue_deadline(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_edit_issue_deadline_with_http_info(owner, repo, index, opts)
  data
end

#issue_edit_issue_deadline_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(IssueDeadline, Integer, Hash)>

Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to create or update a deadline on

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(IssueDeadline, Integer, Hash)>)

    IssueDeadline data, response status code and response headers



2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
# File 'lib/forgejo/api/issue_api.rb', line 2387

def issue_edit_issue_deadline_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_issue_deadline ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_issue_deadline"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_issue_deadline"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_edit_issue_deadline"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/deadline'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_issue_deadline",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_issue_deadline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_issue_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
# File 'lib/forgejo/api/issue_api.rb', line 2135

def issue_edit_issue_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_issue ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_issue"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_issue"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_edit_issue"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_issue",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_label(owner, repo, id, opts = {}) ⇒ Label

Update a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to edit

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

    the optional parameters

Options Hash (opts):

Returns:



2455
2456
2457
2458
# File 'lib/forgejo/api/issue_api.rb', line 2455

def issue_edit_label(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_edit_label_with_http_info(owner, repo, id, opts)
  data
end

#issue_edit_label_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Update a label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Label, Integer, Hash)>)

    Label data, response status code and response headers



2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
# File 'lib/forgejo/api/issue_api.rb', line 2467

def issue_edit_label_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_label"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_edit_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/labels/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_label",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_edit_milestone(owner, repo, id, opts = {}) ⇒ Milestone

Update a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to edit, identified by ID and if not available by name

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

    the optional parameters

Options Hash (opts):

Returns:



2535
2536
2537
2538
# File 'lib/forgejo/api/issue_api.rb', line 2535

def issue_edit_milestone(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_edit_milestone_with_http_info(owner, repo, id, opts)
  data
end

#issue_edit_milestone_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Update a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to edit, identified by ID and if not available by name

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Milestone, Integer, Hash)>)

    Milestone data, response status code and response headers



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
# File 'lib/forgejo/api/issue_api.rb', line 2547

def issue_edit_milestone_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_edit_milestone ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_edit_milestone"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_edit_milestone"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_edit_milestone"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/milestones/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_edit_milestone",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_edit_milestone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_comment(owner, repo, id, opts = {}) ⇒ Comment

Get a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

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

    the optional parameters

Returns:



2614
2615
2616
2617
# File 'lib/forgejo/api/issue_api.rb', line 2614

def issue_get_comment(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_get_comment_with_http_info(owner, repo, id, opts)
  data
end

#issue_get_comment_reactions(owner, repo, id, opts = {}) ⇒ Array<Reaction>

Get a list of reactions from a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Returns:



2687
2688
2689
2690
# File 'lib/forgejo/api/issue_api.rb', line 2687

def issue_get_comment_reactions(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_get_comment_reactions_with_http_info(owner, repo, id, opts)
  data
end

#issue_get_comment_reactions_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Array<Reaction>, Integer, Hash)>

Get a list of reactions from a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Returns:

  • (Array<(Array<Reaction>, Integer, Hash)>)

    Array<Reaction> data, response status code and response headers



2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
# File 'lib/forgejo/api/issue_api.rb', line 2698

def issue_get_comment_reactions_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_comment_reactions ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_comment_reactions"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_comment_reactions"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_get_comment_reactions"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Reaction>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_comment_reactions",
    :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: IssueApi#issue_get_comment_reactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_comment_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

Get a comment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

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

    the optional parameters

Returns:

  • (Array<(Comment, Integer, Hash)>)

    Comment data, response status code and response headers



2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
# File 'lib/forgejo/api/issue_api.rb', line 2625

def issue_get_comment_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_comment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_comment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_comment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_get_comment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_comment",
    :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: IssueApi#issue_get_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_comments(owner, repo, index, opts = {}) ⇒ Array<Comment>

List all comments on an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the specified time are returned.

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

Returns:



2762
2763
2764
2765
# File 'lib/forgejo/api/issue_api.rb', line 2762

def issue_get_comments(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_get_comments_with_http_info(owner, repo, index, opts)
  data
end

#issue_get_comments_and_timeline(owner, repo, index, opts = {}) ⇒ Array<TimelineComment>

List all comments and events on an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the specified time are returned.

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

Returns:



2843
2844
2845
2846
# File 'lib/forgejo/api/issue_api.rb', line 2843

def issue_get_comments_and_timeline(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_get_comments_and_timeline_with_http_info(owner, repo, index, opts)
  data
end

#issue_get_comments_and_timeline_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<TimelineComment>, Integer, Hash)>

List all comments and events on an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the specified time are returned.

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

Returns:

  • (Array<(Array<TimelineComment>, Integer, Hash)>)

    Array<TimelineComment> data, response status code and response headers



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
# File 'lib/forgejo/api/issue_api.rb', line 2858

def issue_get_comments_and_timeline_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_comments_and_timeline ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_comments_and_timeline"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_comments_and_timeline"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_comments_and_timeline"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/timeline'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimelineComment>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_comments_and_timeline",
    :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: IssueApi#issue_get_comments_and_timeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_comments_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Comment>, Integer, Hash)>

List all comments on an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the specified time are returned.

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

Returns:

  • (Array<(Array<Comment>, Integer, Hash)>)

    Array<Comment> data, response status code and response headers



2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'lib/forgejo/api/issue_api.rb', line 2775

def issue_get_comments_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_comments ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_comments"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_comments"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_comments"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/comments'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Comment>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_comments",
    :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: IssueApi#issue_get_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_issue(owner, repo, index, opts = {}) ⇒ Issue

Get an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to get

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

    the optional parameters

Returns:



2924
2925
2926
2927
# File 'lib/forgejo/api/issue_api.rb', line 2924

def issue_get_issue(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_get_issue_with_http_info(owner, repo, index, opts)
  data
end

#issue_get_issue_attachment(owner, repo, index, attachment_id, opts = {}) ⇒ Attachment

Get an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to get

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

    the optional parameters

Returns:



2998
2999
3000
3001
# File 'lib/forgejo/api/issue_api.rb', line 2998

def issue_get_issue_attachment(owner, repo, index, attachment_id, opts = {})
  data, _status_code, _headers = issue_get_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts)
  data
end

#issue_get_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Get an issue attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • attachment_id (Integer)

    id of the attachment to get

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

    the optional parameters

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
# File 'lib/forgejo/api/issue_api.rb', line 3010

def issue_get_issue_attachment_with_http_info(owner, repo, index, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_issue_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_issue_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_issue_attachment"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_issue_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_get_issue_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_issue_attachment",
    :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: IssueApi#issue_get_issue_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_issue_comment_attachment(owner, repo, id, attachment_id, opts = {}) ⇒ Attachment

Get a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to get

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

    the optional parameters

Returns:



3077
3078
3079
3080
# File 'lib/forgejo/api/issue_api.rb', line 3077

def issue_get_issue_comment_attachment(owner, repo, id, attachment_id, opts = {})
  data, _status_code, _headers = issue_get_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts)
  data
end

#issue_get_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Get a comment attachment

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

  • attachment_id (Integer)

    id of the attachment to get

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

    the optional parameters

Returns:

  • (Array<(Attachment, Integer, Hash)>)

    Attachment data, response status code and response headers



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
# File 'lib/forgejo/api/issue_api.rb', line 3089

def issue_get_issue_comment_attachment_with_http_info(owner, repo, id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_issue_comment_attachment ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_issue_comment_attachment"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_issue_comment_attachment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_get_issue_comment_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling IssueApi.issue_get_issue_comment_attachment"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'attachment_id' + '}', CGI.escape(attachment_id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_issue_comment_attachment",
    :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: IssueApi#issue_get_issue_comment_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_issue_reactions(owner, repo, index, opts = {}) ⇒ Array<Reaction>

Get a list reactions of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3157
3158
3159
3160
# File 'lib/forgejo/api/issue_api.rb', line 3157

def issue_get_issue_reactions(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_get_issue_reactions_with_http_info(owner, repo, index, opts)
  data
end

#issue_get_issue_reactions_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Reaction>, Integer, Hash)>

Get a list reactions of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Reaction>, Integer, Hash)>)

    Array<Reaction> data, response status code and response headers



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
# File 'lib/forgejo/api/issue_api.rb', line 3170

def issue_get_issue_reactions_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_issue_reactions ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_issue_reactions"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_issue_reactions"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_issue_reactions"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Reaction>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_issue_reactions",
    :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: IssueApi#issue_get_issue_reactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_issue_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Get an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to get

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

    the optional parameters

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
# File 'lib/forgejo/api/issue_api.rb', line 2935

def issue_get_issue_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_issue ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_issue"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_issue"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_issue"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_issue",
    :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: IssueApi#issue_get_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_label(owner, repo, id, opts = {}) ⇒ Label

Get a single label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to get

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

    the optional parameters

Returns:



3234
3235
3236
3237
# File 'lib/forgejo/api/issue_api.rb', line 3234

def issue_get_label(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_get_label_with_http_info(owner, repo, id, opts)
  data
end

#issue_get_label_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Get a single label

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the label to get

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

    the optional parameters

Returns:

  • (Array<(Label, Integer, Hash)>)

    Label data, response status code and response headers



3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
# File 'lib/forgejo/api/issue_api.rb', line 3245

def issue_get_label_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_label"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_get_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/labels/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_label",
    :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: IssueApi#issue_get_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_labels(owner, repo, index, opts = {}) ⇒ Array<Label>

Get an issue’s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:



3307
3308
3309
3310
# File 'lib/forgejo/api/issue_api.rb', line 3307

def issue_get_labels(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_get_labels_with_http_info(owner, repo, index, opts)
  data
end

#issue_get_labels_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

Get an issue&#39;s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:

  • (Array<(Array<Label>, Integer, Hash)>)

    Array<Label> data, response status code and response headers



3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
# File 'lib/forgejo/api/issue_api.rb', line 3318

def issue_get_labels_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_labels ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_labels"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_labels"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_get_labels"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Label>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_labels",
    :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: IssueApi#issue_get_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_milestone(owner, repo, id, opts = {}) ⇒ Milestone

Get a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to get, identified by ID and if not available by name

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

    the optional parameters

Returns:



3380
3381
3382
3383
# File 'lib/forgejo/api/issue_api.rb', line 3380

def issue_get_milestone(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_get_milestone_with_http_info(owner, repo, id, opts)
  data
end

#issue_get_milestone_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Get a milestone

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (String)

    the milestone to get, identified by ID and if not available by name

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

    the optional parameters

Returns:

  • (Array<(Milestone, Integer, Hash)>)

    Milestone data, response status code and response headers



3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
# File 'lib/forgejo/api/issue_api.rb', line 3391

def issue_get_milestone_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_milestone ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_milestone"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_milestone"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_get_milestone"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/milestones/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_milestone",
    :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: IssueApi#issue_get_milestone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_milestones_list(owner, repo, opts = {}) ⇒ Array<Milestone>

Get all of a repository’s opened milestones

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    Milestone state, Recognized values are open, closed and all. Defaults to &quot;open&quot;

  • :name (String)

    filter by milestone name

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3456
3457
3458
3459
# File 'lib/forgejo/api/issue_api.rb', line 3456

def issue_get_milestones_list(owner, repo, opts = {})
  data, _status_code, _headers = issue_get_milestones_list_with_http_info(owner, repo, opts)
  data
end

#issue_get_milestones_list_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<Milestone>, Integer, Hash)>

Get all of a repository&#39;s opened milestones

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    Milestone state, Recognized values are open, closed and all. Defaults to &quot;open&quot;

  • :name (String)

    filter by milestone name

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Milestone>, Integer, Hash)>)

    Array<Milestone> data, response status code and response headers



3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
# File 'lib/forgejo/api/issue_api.rb', line 3470

def issue_get_milestones_list_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_milestones_list ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_milestones_list"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_milestones_list"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/milestones'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Milestone>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_milestones_list",
    :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: IssueApi#issue_get_milestones_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_get_repo_comments(owner, repo, opts = {}) ⇒ Array<Comment>

List all comments in a repository

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the provided time are returned.

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3535
3536
3537
3538
# File 'lib/forgejo/api/issue_api.rb', line 3535

def issue_get_repo_comments(owner, repo, opts = {})
  data, _status_code, _headers = issue_get_repo_comments_with_http_info(owner, repo, opts)
  data
end

#issue_get_repo_comments_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<Comment>, Integer, Hash)>

List all comments in a repository

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :since (Time)

    if provided, only comments updated since the provided time are returned.

  • :before (Time)

    if provided, only comments updated before the provided time are returned.

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Comment>, Integer, Hash)>)

    Array<Comment> data, response status code and response headers



3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
# File 'lib/forgejo/api/issue_api.rb', line 3549

def issue_get_repo_comments_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_get_repo_comments ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_get_repo_comments"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_get_repo_comments"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Comment>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_get_repo_comments",
    :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: IssueApi#issue_get_repo_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_blocks(owner, repo, index, opts = {}) ⇒ Array<Issue>

List issues that are blocked by this issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3613
3614
3615
3616
# File 'lib/forgejo/api/issue_api.rb', line 3613

def issue_list_blocks(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_list_blocks_with_http_info(owner, repo, index, opts)
  data
end

#issue_list_blocks_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Issue>, Integer, Hash)>

List issues that are blocked by this issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Issue>, Integer, Hash)>)

    Array<Issue> data, response status code and response headers



3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/forgejo/api/issue_api.rb', line 3626

def issue_list_blocks_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_blocks ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_blocks"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_blocks"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_list_blocks"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/blocks'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Issue>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_blocks",
    :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: IssueApi#issue_list_blocks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_issue_attachments(owner, repo, index, opts = {}) ⇒ Array<Attachment>

List issue’s attachments

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:



3690
3691
3692
3693
# File 'lib/forgejo/api/issue_api.rb', line 3690

def issue_list_issue_attachments(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_list_issue_attachments_with_http_info(owner, repo, index, opts)
  data
end

#issue_list_issue_attachments_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Attachment>, Integer, Hash)>

List issue&#39;s attachments

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Returns:

  • (Array<(Array<Attachment>, Integer, Hash)>)

    Array<Attachment> data, response status code and response headers



3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
# File 'lib/forgejo/api/issue_api.rb', line 3701

def issue_list_issue_attachments_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_issue_attachments ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_issue_attachments"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_issue_attachments"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_list_issue_attachments"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/assets'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Attachment>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_issue_attachments",
    :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: IssueApi#issue_list_issue_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_issue_comment_attachments(owner, repo, id, opts = {}) ⇒ Array<Attachment>

List comment’s attachments

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

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

    the optional parameters

Returns:



3763
3764
3765
3766
# File 'lib/forgejo/api/issue_api.rb', line 3763

def issue_list_issue_comment_attachments(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_list_issue_comment_attachments_with_http_info(owner, repo, id, opts)
  data
end

#issue_list_issue_comment_attachments_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Array<Attachment>, Integer, Hash)>

List comment&#39;s attachments

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment

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

    the optional parameters

Returns:

  • (Array<(Array<Attachment>, Integer, Hash)>)

    Array<Attachment> data, response status code and response headers



3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
# File 'lib/forgejo/api/issue_api.rb', line 3774

def issue_list_issue_comment_attachments_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_issue_comment_attachments ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_issue_comment_attachments"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_issue_comment_attachments"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_list_issue_comment_attachments"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/assets'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Attachment>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_issue_comment_attachments",
    :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: IssueApi#issue_list_issue_comment_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_issue_dependencies(owner, repo, index, opts = {}) ⇒ Array<Issue>

List an issue’s dependencies, i.e all issues that block this issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3838
3839
3840
3841
# File 'lib/forgejo/api/issue_api.rb', line 3838

def issue_list_issue_dependencies(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_list_issue_dependencies_with_http_info(owner, repo, index, opts)
  data
end

#issue_list_issue_dependencies_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Issue>, Integer, Hash)>

List an issue&#39;s dependencies, i.e all issues that block this issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Issue>, Integer, Hash)>)

    Array<Issue> data, response status code and response headers



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'lib/forgejo/api/issue_api.rb', line 3851

def issue_list_issue_dependencies_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_issue_dependencies ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_issue_dependencies"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_issue_dependencies"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_list_issue_dependencies"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/dependencies'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Issue>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_issue_dependencies",
    :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: IssueApi#issue_list_issue_dependencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_issues(owner, repo, opts = {}) ⇒ Array<Issue>

List a repository’s issues

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    whether issue is open or closed

  • :labels (String)

    comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded

  • :q (String)

    search string

  • :type (String)

    filter by type (issues / pulls) if set

  • :milestones (String)

    comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded

  • :since (Time)

    Only show items updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show items updated before the given time. This is a timestamp in RFC 3339 format

  • :created_by (String)

    Only show items which were created by the given user

  • :assigned_by (String)

    Only show items for which the given user is assigned

  • :mentioned_by (String)

    Only show items in which the given user was mentioned

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



3926
3927
3928
3929
# File 'lib/forgejo/api/issue_api.rb', line 3926

def issue_list_issues(owner, repo, opts = {})
  data, _status_code, _headers = issue_list_issues_with_http_info(owner, repo, opts)
  data
end

#issue_list_issues_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<Issue>, Integer, Hash)>

List a repository&#39;s issues

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    whether issue is open or closed

  • :labels (String)

    comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded

  • :q (String)

    search string

  • :type (String)

    filter by type (issues / pulls) if set

  • :milestones (String)

    comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded

  • :since (Time)

    Only show items updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show items updated before the given time. This is a timestamp in RFC 3339 format

  • :created_by (String)

    Only show items which were created by the given user

  • :assigned_by (String)

    Only show items for which the given user is assigned

  • :mentioned_by (String)

    Only show items in which the given user was mentioned

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Issue>, Integer, Hash)>)

    Array<Issue> data, response status code and response headers



3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
# File 'lib/forgejo/api/issue_api.rb', line 3948

def issue_list_issues_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_issues ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_issues"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_issues"
  end
  allowable_values = ["closed", "open", "all"]
  if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
    fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
  end
  allowable_values = ["issues", "pulls"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'labels'] = opts[:'labels'] if !opts[:'labels'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'milestones'] = opts[:'milestones'] if !opts[:'milestones'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'created_by'] = opts[:'created_by'] if !opts[:'created_by'].nil?
  query_params[:'assigned_by'] = opts[:'assigned_by'] if !opts[:'assigned_by'].nil?
  query_params[:'mentioned_by'] = opts[:'mentioned_by'] if !opts[:'mentioned_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Issue>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_issues",
    :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: IssueApi#issue_list_issues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_list_labels(owner, repo, opts = {}) ⇒ Array<Label>

Get all of a repository’s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



4027
4028
4029
4030
# File 'lib/forgejo/api/issue_api.rb', line 4027

def issue_list_labels(owner, repo, opts = {})
  data, _status_code, _headers = issue_list_labels_with_http_info(owner, repo, opts)
  data
end

#issue_list_labels_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

Get all of a repository&#39;s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Label>, Integer, Hash)>)

    Array<Label> data, response status code and response headers



4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
# File 'lib/forgejo/api/issue_api.rb', line 4039

def issue_list_labels_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_list_labels ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_list_labels"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_list_labels"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Label>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_list_labels",
    :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: IssueApi#issue_list_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_post_comment_reaction(owner, repo, id, opts = {}) ⇒ Reaction

Add a reaction to a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:



4100
4101
4102
4103
# File 'lib/forgejo/api/issue_api.rb', line 4100

def issue_post_comment_reaction(owner, repo, id, opts = {})
  data, _status_code, _headers = issue_post_comment_reaction_with_http_info(owner, repo, id, opts)
  data
end

#issue_post_comment_reaction_with_http_info(owner, repo, id, opts = {}) ⇒ Array<(Reaction, Integer, Hash)>

Add a reaction to a comment of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • id (Integer)

    id of the comment to edit

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Reaction, Integer, Hash)>)

    Reaction data, response status code and response headers



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'lib/forgejo/api/issue_api.rb', line 4112

def issue_post_comment_reaction_with_http_info(owner, repo, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_post_comment_reaction ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_post_comment_reaction"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_post_comment_reaction"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_post_comment_reaction"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/comments/{id}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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']) unless header_params['Accept']
  # 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(opts[:'content'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_post_comment_reaction",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_post_comment_reaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_post_issue_reaction(owner, repo, index, opts = {}) ⇒ Reaction

Add a reaction to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



4180
4181
4182
4183
# File 'lib/forgejo/api/issue_api.rb', line 4180

def issue_post_issue_reaction(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_post_issue_reaction_with_http_info(owner, repo, index, opts)
  data
end

#issue_post_issue_reaction_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Reaction, Integer, Hash)>

Add a reaction to an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Reaction, Integer, Hash)>)

    Reaction data, response status code and response headers



4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
# File 'lib/forgejo/api/issue_api.rb', line 4192

def issue_post_issue_reaction_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_post_issue_reaction ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_post_issue_reaction"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_post_issue_reaction"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_post_issue_reaction"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/reactions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'content'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_post_issue_reaction",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_post_issue_reaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_remove_issue_blocking(owner, repo, index, opts = {}) ⇒ Issue

Unblock the issue given in the body by the issue in path

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



4260
4261
4262
4263
# File 'lib/forgejo/api/issue_api.rb', line 4260

def issue_remove_issue_blocking(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_remove_issue_blocking_with_http_info(owner, repo, index, opts)
  data
end

#issue_remove_issue_blocking_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Unblock the issue given in the body by the issue in path

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
# File 'lib/forgejo/api/issue_api.rb', line 4272

def issue_remove_issue_blocking_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_remove_issue_blocking ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_remove_issue_blocking"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_remove_issue_blocking"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_remove_issue_blocking"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/blocks'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_remove_issue_blocking",
    :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: IssueApi#issue_remove_issue_blocking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_remove_issue_dependencies(owner, repo, index, opts = {}) ⇒ Issue

Remove an issue dependency

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



4340
4341
4342
4343
# File 'lib/forgejo/api/issue_api.rb', line 4340

def issue_remove_issue_dependencies(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_remove_issue_dependencies_with_http_info(owner, repo, index, opts)
  data
end

#issue_remove_issue_dependencies_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Issue, Integer, Hash)>

Remove an issue dependency

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (String)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Issue, Integer, Hash)>)

    Issue data, response status code and response headers



4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
# File 'lib/forgejo/api/issue_api.rb', line 4352

def issue_remove_issue_dependencies_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_remove_issue_dependencies ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_remove_issue_dependencies"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_remove_issue_dependencies"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_remove_issue_dependencies"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/dependencies'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_remove_issue_dependencies",
    :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: IssueApi#issue_remove_issue_dependencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_remove_label(owner, repo, index, id, opts = {}) ⇒ nil

Remove a label from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • id (Integer)

    id of the label to remove

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


4421
4422
4423
4424
# File 'lib/forgejo/api/issue_api.rb', line 4421

def issue_remove_label(owner, repo, index, id, opts = {})
  issue_remove_label_with_http_info(owner, repo, index, id, opts)
  nil
end

#issue_remove_label_with_http_info(owner, repo, index, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a label from an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

  • id (Integer)

    id of the label to remove

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'lib/forgejo/api/issue_api.rb', line 4434

def issue_remove_label_with_http_info(owner, repo, index, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_remove_label ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_remove_label"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_remove_label"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_remove_label"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IssueApi.issue_remove_label"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/labels/{id}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/plain'])
  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(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_remove_label",
    :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: IssueApi#issue_remove_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_replace_labels(owner, repo, index, opts = {}) ⇒ Array<Label>

Replace an issue’s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:



4504
4505
4506
4507
# File 'lib/forgejo/api/issue_api.rb', line 4504

def issue_replace_labels(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_replace_labels_with_http_info(owner, repo, index, opts)
  data
end

#issue_replace_labels_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

Replace an issue&#39;s labels

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<Label>, Integer, Hash)>)

    Array<Label> data, response status code and response headers



4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
# File 'lib/forgejo/api/issue_api.rb', line 4516

def issue_replace_labels_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_replace_labels ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_replace_labels"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_replace_labels"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_replace_labels"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/labels'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.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']) unless header_params['Accept']
  # 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(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Label>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_replace_labels",
    :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: IssueApi#issue_replace_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_reset_time(owner, repo, index, opts = {}) ⇒ nil

Reset a tracked time of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to add tracked time to

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

    the optional parameters

Returns:

  • (nil)


4583
4584
4585
4586
# File 'lib/forgejo/api/issue_api.rb', line 4583

def issue_reset_time(owner, repo, index, opts = {})
  issue_reset_time_with_http_info(owner, repo, index, opts)
  nil
end

#issue_reset_time_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reset a tracked time of an issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to add tracked time to

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
# File 'lib/forgejo/api/issue_api.rb', line 4594

def issue_reset_time_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_reset_time ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_reset_time"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_reset_time"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_reset_time"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/times'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_reset_time",
    :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: IssueApi#issue_reset_time\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_search_issues(opts = {}) ⇒ Array<Issue>

Search for issues across the repositories that the user has access to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    whether issue is open or closed

  • :labels (String)

    comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded

  • :milestones (String)

    comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded

  • :q (String)

    search string

  • :priority_repo_id (Integer)

    repository to prioritize in the results

  • :type (String)

    filter by type (issues / pulls) if set

  • :since (Time)

    Only show notifications updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show notifications updated before the given time. This is a timestamp in RFC 3339 format

  • :assigned (Boolean)

    filter (issues / pulls) assigned to you, default is false

  • :created (Boolean)

    filter (issues / pulls) created by you, default is false

  • :mentioned (Boolean)

    filter (issues / pulls) mentioning you, default is false

  • :review_requested (Boolean)

    filter pulls requesting your review, default is false

  • :reviewed (Boolean)

    filter pulls reviewed by you, default is false

  • :owner (String)

    filter by owner

  • :team (String)

    filter by team (requires organization owner parameter to be provided)

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



4668
4669
4670
4671
# File 'lib/forgejo/api/issue_api.rb', line 4668

def issue_search_issues(opts = {})
  data, _status_code, _headers = issue_search_issues_with_http_info(opts)
  data
end

#issue_search_issues_with_http_info(opts = {}) ⇒ Array<(Array<Issue>, Integer, Hash)>

Search for issues across the repositories that the user has access to

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String)

    whether issue is open or closed

  • :labels (String)

    comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded

  • :milestones (String)

    comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded

  • :q (String)

    search string

  • :priority_repo_id (Integer)

    repository to prioritize in the results

  • :type (String)

    filter by type (issues / pulls) if set

  • :since (Time)

    Only show notifications updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show notifications updated before the given time. This is a timestamp in RFC 3339 format

  • :assigned (Boolean)

    filter (issues / pulls) assigned to you, default is false

  • :created (Boolean)

    filter (issues / pulls) created by you, default is false

  • :mentioned (Boolean)

    filter (issues / pulls) mentioning you, default is false

  • :review_requested (Boolean)

    filter pulls requesting your review, default is false

  • :reviewed (Boolean)

    filter pulls reviewed by you, default is false

  • :owner (String)

    filter by owner

  • :team (String)

    filter by team (requires organization owner parameter to be provided)

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<Issue>, Integer, Hash)>)

    Array<Issue> data, response status code and response headers



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'lib/forgejo/api/issue_api.rb', line 4693

def issue_search_issues_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_search_issues ...'
  end
  # resource path
  local_var_path = '/repos/issues/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'labels'] = opts[:'labels'] if !opts[:'labels'].nil?
  query_params[:'milestones'] = opts[:'milestones'] if !opts[:'milestones'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'priority_repo_id'] = opts[:'priority_repo_id'] if !opts[:'priority_repo_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'assigned'] = opts[:'assigned'] if !opts[:'assigned'].nil?
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'mentioned'] = opts[:'mentioned'] if !opts[:'mentioned'].nil?
  query_params[:'review_requested'] = opts[:'review_requested'] if !opts[:'review_requested'].nil?
  query_params[:'reviewed'] = opts[:'reviewed'] if !opts[:'reviewed'].nil?
  query_params[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?
  query_params[:'team'] = opts[:'team'] if !opts[:'team'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Issue>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_search_issues",
    :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: IssueApi#issue_search_issues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_start_stop_watch(owner, repo, index, opts = {}) ⇒ nil

Start stopwatch on an issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to create the stopwatch on

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

    the optional parameters

Returns:

  • (nil)


4760
4761
4762
4763
# File 'lib/forgejo/api/issue_api.rb', line 4760

def issue_start_stop_watch(owner, repo, index, opts = {})
  issue_start_stop_watch_with_http_info(owner, repo, index, opts)
  nil
end

#issue_start_stop_watch_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Start stopwatch on an issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to create the stopwatch on

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'lib/forgejo/api/issue_api.rb', line 4771

def issue_start_stop_watch_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_start_stop_watch ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_start_stop_watch"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_start_stop_watch"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_start_stop_watch"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/stopwatch/start'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_start_stop_watch",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_start_stop_watch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_stop_stop_watch(owner, repo, index, opts = {}) ⇒ nil

Stop an issue’s existing stopwatch.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to stop the stopwatch on

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

    the optional parameters

Returns:

  • (nil)


4831
4832
4833
4834
# File 'lib/forgejo/api/issue_api.rb', line 4831

def issue_stop_stop_watch(owner, repo, index, opts = {})
  issue_stop_stop_watch_with_http_info(owner, repo, index, opts)
  nil
end

#issue_stop_stop_watch_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Stop an issue&#39;s existing stopwatch.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue to stop the stopwatch on

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
# File 'lib/forgejo/api/issue_api.rb', line 4842

def issue_stop_stop_watch_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_stop_stop_watch ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_stop_stop_watch"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_stop_stop_watch"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_stop_stop_watch"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/stopwatch/stop'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.issue_stop_stop_watch",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#issue_stop_stop_watch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_subscriptions(owner, repo, index, opts = {}) ⇒ Array<User>

Get users who subscribed on an issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



4904
4905
4906
4907
# File 'lib/forgejo/api/issue_api.rb', line 4904

def issue_subscriptions(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_subscriptions_with_http_info(owner, repo, index, opts)
  data
end

#issue_subscriptions_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

Get users who subscribed on an issue.

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<User>, Integer, Hash)>)

    Array<User> data, response status code and response headers



4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'lib/forgejo/api/issue_api.rb', line 4917

def issue_subscriptions_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_subscriptions ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_subscriptions"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_subscriptions"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_subscriptions"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/subscriptions'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<User>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_subscriptions",
    :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: IssueApi#issue_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_tracked_times(owner, repo, index, opts = {}) ⇒ Array<TrackedTime>

List an issue’s tracked times

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :user (String)

    optional filter by user (available for issue managers)

  • :since (Time)

    Only show times updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show times updated before the given time. This is a timestamp in RFC 3339 format

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:



4986
4987
4988
4989
# File 'lib/forgejo/api/issue_api.rb', line 4986

def issue_tracked_times(owner, repo, index, opts = {})
  data, _status_code, _headers = issue_tracked_times_with_http_info(owner, repo, index, opts)
  data
end

#issue_tracked_times_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(Array<TrackedTime>, Integer, Hash)>

List an issue&#39;s tracked times

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of the issue

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

    the optional parameters

Options Hash (opts):

  • :user (String)

    optional filter by user (available for issue managers)

  • :since (Time)

    Only show times updated after the given time. This is a timestamp in RFC 3339 format

  • :before (Time)

    Only show times updated before the given time. This is a timestamp in RFC 3339 format

  • :page (Integer)

    page number of results to return (1-based)

  • :limit (Integer)

    page size of results

Returns:

  • (Array<(Array<TrackedTime>, Integer, Hash)>)

    Array<TrackedTime> data, response status code and response headers



5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
# File 'lib/forgejo/api/issue_api.rb', line 5002

def issue_tracked_times_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.issue_tracked_times ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.issue_tracked_times"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.issue_tracked_times"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.issue_tracked_times"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/times'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user'] = opts[:'user'] if !opts[:'user'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TrackedTime>'

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

  new_options = opts.merge(
    :operation => :"IssueApi.issue_tracked_times",
    :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: IssueApi#issue_tracked_times\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_issue_pin(owner, repo, index, position, opts = {}) ⇒ nil

Moves the Pin to the given Position

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue

  • position (Integer)

    the new position

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

    the optional parameters

Returns:

  • (nil)


5070
5071
5072
5073
# File 'lib/forgejo/api/issue_api.rb', line 5070

def move_issue_pin(owner, repo, index, position, opts = {})
  move_issue_pin_with_http_info(owner, repo, index, position, opts)
  nil
end

#move_issue_pin_with_http_info(owner, repo, index, position, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Moves the Pin to the given Position

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue

  • position (Integer)

    the new position

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
# File 'lib/forgejo/api/issue_api.rb', line 5082

def move_issue_pin_with_http_info(owner, repo, index, position, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.move_issue_pin ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.move_issue_pin"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.move_issue_pin"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.move_issue_pin"
  end
  # verify the required parameter 'position' is set
  if @api_client.config.client_side_validation && position.nil?
    fail ArgumentError, "Missing the required parameter 'position' when calling IssueApi.move_issue_pin"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/pin/{position}'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s)).sub('{' + 'position' + '}', CGI.escape(position.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.move_issue_pin",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#move_issue_pin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pin_issue(owner, repo, index, opts = {}) ⇒ nil

Pin an Issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to pin

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

    the optional parameters

Returns:

  • (nil)


5146
5147
5148
5149
# File 'lib/forgejo/api/issue_api.rb', line 5146

def pin_issue(owner, repo, index, opts = {})
  pin_issue_with_http_info(owner, repo, index, opts)
  nil
end

#pin_issue_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Pin an Issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to pin

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
# File 'lib/forgejo/api/issue_api.rb', line 5157

def pin_issue_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.pin_issue ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.pin_issue"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.pin_issue"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.pin_issue"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/pin'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.pin_issue",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IssueApi#pin_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin_issue(owner, repo, index, opts = {}) ⇒ nil

Unpin an Issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to unpin

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

    the optional parameters

Returns:

  • (nil)


5217
5218
5219
5220
# File 'lib/forgejo/api/issue_api.rb', line 5217

def unpin_issue(owner, repo, index, opts = {})
  unpin_issue_with_http_info(owner, repo, index, opts)
  nil
end

#unpin_issue_with_http_info(owner, repo, index, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unpin an Issue

Parameters:

  • owner (String)

    owner of the repo

  • repo (String)

    name of the repo

  • index (Integer)

    index of issue to unpin

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
# File 'lib/forgejo/api/issue_api.rb', line 5228

def unpin_issue_with_http_info(owner, repo, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IssueApi.unpin_issue ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling IssueApi.unpin_issue"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling IssueApi.unpin_issue"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling IssueApi.unpin_issue"
  end
  # resource path
  local_var_path = '/repos/{owner}/{repo}/issues/{index}/pin'.sub('{' + 'owner' + '}', CGI.escape(owner.to_s)).sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'index' + '}', CGI.escape(index.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['AuthorizationHeaderToken']

  new_options = opts.merge(
    :operation => :"IssueApi.unpin_issue",
    :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: IssueApi#unpin_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end