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

Extend logbook api to be able to fetch a slice of data between two time boundaries. #35847

Merged
merged 4 commits into from
Jun 3, 2020

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 20, 2020

Proposed change

Extend logbook api to be able to fetch a slice of data between two time boundaries.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@bdraco bdraco force-pushed the logbook_time_slice branch from 76e7570 to ee479f0 Compare June 3, 2020 01:43
@bdraco
Copy link
Member Author

bdraco commented Jun 3, 2020

@bramkragten Is this going to work for the frontend to be able to get slices of the logbook between two datetimes? /api/logbook/{start_datetime}?end_datetime={end_datetime}

@bramkragten
Copy link
Member

Yes, that's perfect :-)

@bdraco bdraco marked this pull request as ready for review June 3, 2020 17:57
@bdraco bdraco changed the title Create logbook_timeslice api Extend logbook api to be able to fetch a slice of data between two time boundaries. Jun 3, 2020
@bdraco
Copy link
Member Author

bdraco commented Jun 3, 2020

I'm going to change it to end_time to be consistent with the history api

@bdraco
Copy link
Member Author

bdraco commented Jun 3, 2020

Looks like the logbook api isn't documented. Probably best to wait to do so until the frontend changes are done in case we have to change something again

https://developers.home-assistant.io/docs/api/rest/

@bdraco bdraco merged commit 751e2f4 into home-assistant:dev Jun 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants