Skip to content

Commit

Permalink
events: Add missing and mark deprecated fields (#754)
Browse files Browse the repository at this point in the history
* events: Document renamed field in Local|RemoteChangeDetected.

Another field "folder" was added besides "folderID", deprecating the
latter.  Add the missing new field and mention this deprecation
explicitly.

* events: Document renamed and missing fields in LocalIndexUpdated.

Another field "sequence" was added besides "version", deprecating the
latter.  Add all missing fields and mention this deprecation
explicitly.
  • Loading branch information
acolomb authored May 8, 2022
1 parent 6101f2d commit 10877e9
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
5 changes: 5 additions & 0 deletions events/localchangedetected.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,14 @@ local filesystem.
"type": "LocalChangeDetected",
"data": {
"action": "deleted",
"folder": "vitwy-zjxqt",
"folderID": "vitwy-zjxqt",
"label": "TestSync",
"path": "C:\\Users\\Nate\\Sync\\testfolder\\test file.rtf",
"type": "file"
}
}
.. deprecated:: v1.1.2
The ``folderID`` field is a legacy name kept only for compatibility. Use the
``folder`` field with identical content instead.
11 changes: 11 additions & 0 deletions events/localindexupdated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,16 @@ changes during a scan.
"data": {
"folder": "default",
"items": 1000,
"filenames": [
"foo",
"bar",
"baz"
],
"sequence": 12345,
"version": 12345
}
}
.. deprecated:: v1.10.0
The ``version`` field is a legacy name kept only for compatibility. Use the
``sequence`` field with identical content instead.
7 changes: 6 additions & 1 deletion events/remotechangedetected.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,16 @@ Files that are updated locally produce a :doc:`localchangedetected` event.
"data" : {
"type" : "file",
"action" : "deleted",
"folder": "Dokumente",
"folderID" : "Dokumente",
"path" : "/media/ntfs_data/Dokumente/testfile",
"label" : "Dokumente",
"folderID" : "Dokumente",
"modifiedBy" : "BPDFDTU"
},
"type" : "RemoteChangeDetected",
"id" : 2
}
.. deprecated:: v1.1.2
The ``folderID`` field is a legacy name kept only for compatibility. Use the
``folder`` field with identical content instead.

0 comments on commit 10877e9

Please sign in to comment.