Skip to content

Prepare for deprecation of API methods #35

@whazzmaster

Description

@whazzmaster

From the Fitbit API documentation:

Custom Logging Endpoints

The following API endpoints are deprecated and will be removed at a future date:

  • API-Get-Heart-Rate (will be replaced with heart rate time series endpoints)
  • API-Log-Heart-Rate
  • API-Delete-Heart-Rate-Log
  • API-Get-Blood-Pressure
  • API-Log-Blood-Pressure
  • API-Delete-Blood-Pressure-Log
  • API-Get-Glucose
  • API-Log-Glucose
  • API-Get-Body-Measurements
  • API-Log-Body-Measurements

All measurements except fat and weight will be removed from:

  • API-Get-Body-Measurements
  • API-Log-Body-Measurements

We're going to need to figure out how we're going to handle the deprecation. In the past I've retained the methods in the gem but raised DeprecatedApiError with a message.

For the next minor version bump we'll add Kernel#warn messages about the future deprecation, and then a minor or major version bump when they ultimately remove the functionality from the API. The issue is that we hadn't bumped the gem to v1.0.0 yet because the API was still in Beta and more breaking changes may have been anticipated. I need to find out how Fitbit classifies the API at this point, as our version structure should broadly mirror the service it proxies.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions