diff --git a/changedetectionio/api/Search.py b/changedetectionio/api/Search.py index c36c597b1..c403e043e 100644 --- a/changedetectionio/api/Search.py +++ b/changedetectionio/api/Search.py @@ -13,11 +13,14 @@ class Search(Resource): @api {get} /api/v1/search Search for watches @apiDescription Search watches by URL or title text @apiExample {curl} Example usage: - curl "http://localhost:5000/api/v1/search?q=example.com" -H"x-api-key:813031b16330fe25e3780cf0325daa45" + curl "http://localhost:5000/api/v1/search?q=https://example.com/page1" -H"x-api-key:813031b16330fe25e3780cf0325daa45" + curl "http://localhost:5000/api/v1/search?q=https://example.com/page1?tag=Favourites" -H"x-api-key:813031b16330fe25e3780cf0325daa45" + curl "http://localhost:5000/api/v1/search?q=https://example.com?partial=true" -H"x-api-key:813031b16330fe25e3780cf0325daa45" @apiName Search @apiGroup Watch Management @apiQuery {String} q Search query to match against watch URLs and titles - @apiQuery {String} [tag] Optional name of tag to limit results + @apiQuery {String} [tag] Optional name of tag to limit results (name not UUID) + @apiQuery {String} [partial] Allow partial matching of URL query @apiSuccess (200) {Object} JSON Object containing matched watches """ query = request.args.get('q', '').strip()