Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

feat(apis): add Task API #126

Merged
merged 2 commits into from
Nov 14, 2022
Merged

feat(apis): add Task API #126

merged 2 commits into from
Nov 14, 2022

Conversation

bednar
Copy link
Contributor

@bednar bednar commented Nov 11, 2022

Closes #125

Proposed Changes

Added Tasks API:

# credentials
url = 'http://localhost:8086'
token = 'my-token'
org = "my-org"

# init client
@main_client = InfluxDB2::Client.new(url, token)
@client = InfluxDB2::API::Client.new(@main_client)
@my_org = @client.create_organizations_api.get_orgs.orgs.select { |organization| organization.name == org }.first

# define task
flux = 'option task = {name: "my-task", every: 1h}

from(bucket: "telegraf")
|> range(start: -1h)
|> filter(fn: (r) => r._measurement == "cpu")
|> filter(fn: (r) => r._field == "usage_system")'

# create
create_request = InfluxDB2::API::TaskCreateRequest.new(org_id: @my_org.id,
                                                       description: 'This task testing API',
                                                       flux: flux,
                                                       status: InfluxDB2::API::TaskStatusType::ACTIVE)

task = @client.create_tasks_api.post_tasks(create_request)
puts task

# update
update_request = InfluxDB2::API::TaskUpdateRequest.new(flux: task.flux,
                                                       description: 'Updated description for testing Task')
task = @client.create_tasks_api.patch_tasks_id(task.id, update_request)
puts task

# list
tasks = @client.create_tasks_api.get_tasks.tasks
puts tasks

# delete
@client.create_tasks_api.delete_tasks_id(task.id)

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • A test has been added if appropriate
  • rake test completes successfully
  • Commit messages are conventional
  • Sign CLA (if not already signed)

@bednar bednar marked this pull request as ready for review November 11, 2022 13:11
@codecov-commenter
Copy link

codecov-commenter commented Nov 11, 2022

Codecov Report

Base: 51.12% // Head: 48.19% // Decreases project coverage by -2.92% ⚠️

Coverage data is based on head (580e108) compared to base (6fef96a).
Patch coverage: 36.48% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #126      +/-   ##
==========================================
- Coverage   51.12%   48.19%   -2.93%     
==========================================
  Files          65       77      +12     
  Lines        6355     7942    +1587     
==========================================
+ Hits         3249     3828     +579     
- Misses       3106     4114    +1008     
Impacted Files Coverage Δ
apis/lib/influxdb2/apis/generated/models/logs.rb 23.65% <23.65%> (ø)
apis/lib/influxdb2/apis/generated/models/runs.rb 23.95% <23.95%> (ø)
...s/lib/influxdb2/apis/generated/models/log_event.rb 24.48% <24.48%> (ø)
...s/lib/influxdb2/apis/generated/models/run_links.rb 24.48% <24.48%> (ø)
apis/lib/influxdb2/apis/generated/models/run.rb 26.81% <26.81%> (ø)
apis/lib/influxdb2/apis/generated/api/tasks_api.rb 28.37% <28.37%> (ø)
apis/lib/influxdb2/apis/generated/models/tasks.rb 46.87% <46.87%> (ø)
.../lib/influxdb2/apis/generated/models/task_links.rb 47.66% <47.66%> (ø)
apis/lib/influxdb2/apis/generated/models/task.rb 49.71% <49.71%> (ø)
...uxdb2/apis/generated/models/task_create_request.rb 51.81% <51.81%> (ø)
... and 4 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@bednar bednar merged commit 7297785 into master Nov 14, 2022
@bednar bednar deleted the tasks_api branch November 14, 2022 12:12
@bednar bednar added this to the 2.9.0 milestone Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support for Task CRUD apis
3 participants