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

api documentation for read is not yet updated for v2 #211

Closed
hoanhan101 opened this issue Oct 15, 2018 · 1 comment · Fixed by #214
Closed

api documentation for read is not yet updated for v2 #211

hoanhan101 opened this issue Oct 15, 2018 · 1 comment · Fixed by #214

Comments

@hoanhan101
Copy link
Contributor

In the read section, instead of

{
  "type": "temperature",
  "data": [
    {
      "value": 20.3,
      "timestamp": "2018-02-01T13:47:40.395939895Z",
      "unit": {
        "symbol": "C",
        "name": "degrees celsius"
      },
      "type": "temperature",
      "info": ""
    }
  ]
}

should it be?

{
  "kind": "temperature",
  "data": [
    {
      "value": 20.3,
      "timestamp": "2018-02-01T13:47:40.395939895Z",
      "unit": {
        "symbol": "C",
        "name": "degrees celsius"
      },
      "type": "temperature",
      "info": ""
    }
  ]
}

The only difference is the top level kind/type of a read response, in which kind is the latest one we are using.

It's also worthwhile to go through the documentation again and make sure we don't miss anything else either.

@edaniszewski
Copy link
Contributor

yes -- good catch, that should be updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants