influxdata / influxdata/kapacitor

HTTP api docs: incorrect format and examples of dates of recordings

Open
#936 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
2.4k
Forks
479
Avg merge
4d 16h
Merged PRs (30d)
4

Description

OS: OS X
Kapacitor: 1.0.0
pre-built package

As written in docs, dates of recordings('start', 'stop') are RFC3339Nano formatted. However, the server-side actually accept an ISOString.

For example, the incorrect parameters:

``` json
{
"task" : "TASK_ID",
"stop" : "2006-01-02T15:04:05Z07:00"
}
```

Will get an error: `"parsing time \"\"2006-01-02T15:04:05Z07:00\"\" as \"\"2006-01-02T15:04:05Z07:00\"\": cannot parse \"07:00\"\" as \"\"\""`

And with the correct parameters:

``` json
{
"task" : "TASK_ID",
"stop" : "2006-01-02T15:04:05Z"
}
```

Successfully submit to the server.

Contributor guide

Open the contributing guide

Research direction

Start by locating the HTTP API documentation for recording requests and the examples using the `start` and `stop` parameters. Update the documented date format and examples to match the accepted ISOString form, then verify that the request example is consistent with the reported server behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.