Skip to content

Commit

Permalink
fix docs: pruneBefore
Browse files Browse the repository at this point in the history
  • Loading branch information
korelstar committed Jun 20, 2020
1 parent fe9517c commit a888a07
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/api/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ All defined routes in the specification are appended to this url. To access all
|:------|:-----|:-----|:-----|
| `category` | string, optional | Filter the result by category name, e.g. `?category=recipes`. Notes with another category are not included in the result. *Compatibility note:* in API v1.0, this parameter is ignored; i.e., the result contains all notes regardless of this parameter. | 1.1 |
| `exclude` | string, optional | Fields which should be excluded from response, seperated with a comma e.g.: `?exclude=content,title`. You can use this in order to reduce transferred data size if you are interested in specific attributes, only. | 1.0 |
| `purgeBefore` | integer, optional | All notes without change before of this Unix timestamp are purged from the response, i.e. only the attribute `id` is included. You should use the Unix timestamp value from the last request's HTTP response header `Last-Modified` in order to reduce transferred data size. | 1.0 |
| `pruneBefore` | integer, optional | All notes without change before of this Unix timestamp are purged from the response, i.e. only the attribute `id` is included. You should use the Unix timestamp value from the last request's HTTP response header `Last-Modified` in order to reduce transferred data size. | 1.0 |
| `If-None-Match` | HTTP header, optional | Use this in order to reduce transferred data size (see [HTTP ETag](https://en.wikipedia.org/wiki/HTTP_ETag)). You should use the value from the last request's HTTP response header `ETag`. | 1.0 |

#### Response
Expand Down
2 changes: 1 addition & 1 deletion src/store/notes.js
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ const actions = {
for (const note of notes) {
noteIds[note.id] = true
// TODO check for parallel (local) changes!
// only update, if note has changes (see API "purgeBefore")
// only update, if note has changes (see API "pruneBefore")
if (note.title !== undefined) {
context.commit('updateNote', note)
}
Expand Down

0 comments on commit a888a07

Please sign in to comment.