search

syncthing / docs

Documentation site
http://docs.syncthing.net/
243 stars 505 forks source link

events: Mention events not in the default event type mask (fixes #404) #741

Closed acolomb closed 2 years ago

acolomb commented 2 years ago

Add a note to LocalChangeDetected and RemoteChangeDetected events about needing to explicitly select them on the /rest/events endpoint.

Simplify cross-references along the way.

acolomb commented 2 years ago

From the linked issue, one point is still not addressed: ItemStarted and ItemFinished are still contained in the DefaultEventMask. That would need "fixing" in the main repo, but is a potentially breaking change. Opening a PR just to add a FIXME comment about that seemed overkill ;-)

acolomb commented 2 years ago

From the linked issue, one point is still not addressed: ItemStarted and ItemFinished are still contained in the DefaultEventMask. That would need "fixing" in the main repo, but is a potentially breaking change. Opening a PR just to add a FIXME comment about that seemed overkill ;-)

The main place where I'd expect a note about what is returned without specifying a mask, is on the endpoint/mask parameter description itself

It used to be there, but was removed during some restructuring, as discussed in the linked issue. I wouldn't mind if it was mentioned there, especially since the inverse filter on the other (kind of deprecated?) endpoint is on the same page. But for troubleshooting issues like #404, I think my approach is more likely to get noticed.