From 1c74944ccaba6aebb7501fb6b67f5327850f060e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Colomb?= Date: Mon, 7 Feb 2022 08:51:09 +0100 Subject: [PATCH] lib/api: Fix comments for endpoint parameters (#8163) --- lib/api/api.go | 6 +++--- lib/model/model.go | 5 ++--- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/api/api.go b/lib/api/api.go index 7a4f96ed8..35d7e1a13 100644 --- a/lib/api/api.go +++ b/lib/api/api.go @@ -248,11 +248,11 @@ func (s *service) Serve(ctx context.Context) error { restMux.HandlerFunc(http.MethodGet, "/rest/db/ignores", s.getDBIgnores) // folder restMux.HandlerFunc(http.MethodGet, "/rest/db/need", s.getDBNeed) // folder [perpage] [page] restMux.HandlerFunc(http.MethodGet, "/rest/db/remoteneed", s.getDBRemoteNeed) // device folder [perpage] [page] - restMux.HandlerFunc(http.MethodGet, "/rest/db/localchanged", s.getDBLocalChanged) // folder + restMux.HandlerFunc(http.MethodGet, "/rest/db/localchanged", s.getDBLocalChanged) // folder [perpage] [page] restMux.HandlerFunc(http.MethodGet, "/rest/db/status", s.getDBStatus) // folder restMux.HandlerFunc(http.MethodGet, "/rest/db/browse", s.getDBBrowse) // folder [prefix] [dirsonly] [levels] restMux.HandlerFunc(http.MethodGet, "/rest/folder/versions", s.getFolderVersions) // folder - restMux.HandlerFunc(http.MethodGet, "/rest/folder/errors", s.getFolderErrors) // folder + restMux.HandlerFunc(http.MethodGet, "/rest/folder/errors", s.getFolderErrors) // folder [perpage] [page] restMux.HandlerFunc(http.MethodGet, "/rest/folder/pullerrors", s.getFolderErrors) // folder (deprecated) restMux.HandlerFunc(http.MethodGet, "/rest/events", s.getIndexEvents) // [since] [limit] [timeout] [events] restMux.HandlerFunc(http.MethodGet, "/rest/events/disk", s.getDiskEvents) // [since] [limit] [timeout] @@ -275,7 +275,7 @@ func (s *service) Serve(ctx context.Context) error { restMux.HandlerFunc(http.MethodGet, "/rest/system/log.txt", s.getSystemLogTxt) // [since] // The POST handlers - restMux.HandlerFunc(http.MethodPost, "/rest/db/prio", s.postDBPrio) // folder file [perpage] [page] + restMux.HandlerFunc(http.MethodPost, "/rest/db/prio", s.postDBPrio) // folder file restMux.HandlerFunc(http.MethodPost, "/rest/db/ignores", s.postDBIgnores) // folder restMux.HandlerFunc(http.MethodPost, "/rest/db/override", s.postDBOverride) // folder restMux.HandlerFunc(http.MethodPost, "/rest/db/revert", s.postDBRevert) // folder diff --git a/lib/model/model.go b/lib/model/model.go index 45536cf4e..819bb3718 100644 --- a/lib/model/model.go +++ b/lib/model/model.go @@ -1006,9 +1006,8 @@ func (m *model) NeedFolderFiles(folder string, page, perpage int) ([]db.FileInfo return progress, queued, rest, nil } -// RemoteNeedFolderFiles returns paginated list of currently needed files in -// progress, queued, and to be queued on next puller iteration, as well as the -// total number of files currently needed. +// RemoteNeedFolderFiles returns paginated list of currently needed files for a +// remote device to become synced with a folder. func (m *model) RemoteNeedFolderFiles(folder string, device protocol.DeviceID, page, perpage int) ([]db.FileInfoTruncated, error) { m.fmut.RLock() rf, ok := m.folderFiles[folder]