Skip to content

Commit

Permalink
Datums - Update parameter tables for datum endpoints
Browse files Browse the repository at this point in the history
Adds instructions about submitting multiple data points in one operation.
Swaps the parameter name from datum to "Request Body" for single data endpoints.
Fixes #58
  • Loading branch information
tyeth committed Oct 24, 2024
1 parent 2ff57ef commit 2f8db6b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion source/includes/cookbook/_sending_json.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ atob("eyJzb21ldGhpbmciOiJoZXJlIn0=")
```
<% end %>

This solution is also ideal if you want to store or send binary data with Adafruit IO. You won't get to see any pretty charts, but your data will remain exactly the way you left it.
This solution is also ideal if you want to store or send binary data with Adafruit IO. You won't get to see any pretty charts (although we do display base64 encoded images), but your data will remain exactly the way you left it.
8 changes: 4 additions & 4 deletions source/includes/http/_data.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can create, read, update, or delete data records. Every **CREATE**, **UPDATE

Data points belong to feeds, so every Data API call starts with a Feed URL.


Note that there are endpoints for submitting multiple data points to a feed, and multiple feed values to a group, see **feeds/{feed_key}/batch** and **groups/{groupname}/data** endpoints.

## Create Data

Expand Down Expand Up @@ -76,7 +76,7 @@ feed_key | string | true | a valid feed key

Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).



Expand Down Expand Up @@ -562,7 +562,7 @@ id | string | true |

Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).



Expand Down Expand Up @@ -724,7 +724,7 @@ feed_key | string | true | a valid feed key

Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).



Expand Down
2 changes: 2 additions & 0 deletions source/includes/http/_feeds.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ You will need to create one feed for each unique source of data you send to Adaf

You can create, read, update, or delete feeds. Every **CREATE**, **UPDATE**, or **DELETE** action on a feed record counts against your rate limit.

There are also endpoints for submitting multiple data points to a feed, or multiple feed values to a group, see **feeds/{feed_key}/batch** and **groups/{groupname}/data** endpoints.

## All Feeds

> HTTP Request
Expand Down
1 change: 1 addition & 0 deletions source/includes/http/_groups.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ For example, if you are building a weather station, you would add feeds for `hum

You can create, read, update, or delete group records. Every **CREATE**, **UPDATE**, or **DELETE** action on a group record counts against your rate limit.

There is also an endpoint for submitting multiple feed values to a group, see the **groups/{groupname}/data** endpoint.

## Get All Groups

Expand Down

0 comments on commit 2f8db6b

Please sign in to comment.