Skip to content

Commit

Permalink
Fixes several issues with the API (#546)
Browse files Browse the repository at this point in the history
* fix issues with the API
  • Loading branch information
Nathaniel Cook committed May 13, 2016
1 parent ce28f6d commit 40c4a1d
Show file tree
Hide file tree
Showing 6 changed files with 744 additions and 170 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,28 @@

### Bugfixes

## v0.13.1 [unreleased]

### Release Notes

>**Breaking changes may require special upgrade steps from versions <= 0.12, please read the 0.13.0 release notes**
Along with the API changes of 0.13.0, validation logic was added to task IDs, but this was not well documented.
This minor release remedies that.

All IDs (tasks, recordings, replays) must match this regex `^[-\._\p{L}0-9]+$`, which is essentially numbers, unicode letters, '-', '.' and '_'.

If you have existing tasks which do not match this pattern they should continue to function normally.

### Features


### Bugfixes

- [#545](https://github.com/influxdata/kapacitor/issues/545): Fixes inconsistancy with API docs for creating a task.
- [#544](https://github.com/influxdata/kapacitor/issues/544): Fixes issues with existings tasks and invalid names.
- [#543](https://github.com/influxdata/kapacitor/issues/543): Fixes default values not being set correctly in API calls.


## v0.13.0 [2016-05-11]

Expand Down
10 changes: 9 additions & 1 deletion client/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ Query parameters are used only for GET requests and all other requests expect pa
When creating resources in Kapacitor the API server will return a `link` object with an `href` of the resource.
Clients should not need to perform path manipulation in most cases and can use the links provided from previous calls.

### IDs

The API allows the client to specify IDs for the various resources.
This way you can control the meaning of the IDs.
If you do not specify an ID a random UUID will be generated for the resource.

All IDs must match this regex `^[-\._\p{L}0-9]+$`, which is essentially numbers, unicode letters, '-', '.' and '_'.

## Writing Data

Kapacitor can accept writes over HTTP using the line protocol.
Expand Down Expand Up @@ -107,7 +115,7 @@ When using PATCH, if any option is missing it will be left unmodified.
Create a new task with ID TASK_ID.

```
POST /kapacitor/v1/tasks/
POST /kapacitor/v1/tasks
{
"id" : "TASK_ID",
"type" : "stream",
Expand Down
Loading

0 comments on commit 40c4a1d

Please sign in to comment.