Self-Hosted
/
changedetection.io
mirror of https://github.com/dgtlmoon/changedetection.io.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

API documentation - improving example for list watches

Browse Source
pull/1430/head
dgtlmoon 2 years ago
parent c747cf7ba8
commit 3b96e40464
3 changed files with 42 additions and 11 deletions
Show Stats Download Patch File Download Diff File

20
changedetectionio/api/api_v1.py
Unescape View File

@ -233,12 +233,28 @@ class CreateWatch(Resource):
@apiDescription Return concise list of available watches and some very basic info @apiDescription Return concise list of available watches and some very basic info
@apiExample {curl} Example usage: @apiExample {curl} Example usage:
curl http://localhost:4000/api/v1/watch -H"x-api-key:813031b16330fe25e3780cf0325daa45" curl http://localhost:4000/api/v1/watch -H"x-api-key:813031b16330fe25e3780cf0325daa45"
recheck_all=1 to recheck all {
"6a4b7d5c-fee4-4616-9f43-4ac97046b595": {
"last_changed": 1677103794,
"last_checked": 1677103794,
"last_error": false,
"title": "",
"url": "http://www.quotationspage.com/random.php"
},
"e6f5fd5c-dbfe-468b-b8f3-f9d6ff5ad69b": {
"last_changed": 0,
"last_checked": 1676662819,
"last_error": false,
"title": "QuickLook",
"url": "https://github.com/QL-Win/QuickLook/tags"
}
}
@apiParam {String} [recheck_all] Optional Set to =1 to force recheck of all watches @apiParam {String} [recheck_all] Optional Set to =1 to force recheck of all watches
@apiParam {String} [tag] Optional name of tag to limit results @apiParam {String} [tag] Optional name of tag to limit results
@apiName ListWatches @apiName ListWatches
@apiGroup Watch Management @apiGroup Watch Management
@apiSuccess (200) {String} OK Was created @apiSuccess (200) {String} OK JSON dict
""" """
list = {} list = {}

17
docs/api_v1/assets/main.bundle.js
View File

File diff suppressed because one or more lines are too long

16
docs/api_v1/index.html
Unescape View File

@ -5,13 +5,13 @@
<meta name="description" content="Manage your changedetection.io watches via API, requires the `x-api-key` header which is found in the settings UI."> <meta name="description" content="Manage your changedetection.io watches via API, requires the `x-api-key` header which is found in the settings UI.">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="assets/bootstrap.min.css?v=1677105536216" rel="stylesheet" media="screen"> <link href="assets/bootstrap.min.css?v=1677105736053" rel="stylesheet" media="screen">
<link href="assets/prism.css?v=1677105536216" rel="stylesheet" /> <link href="assets/prism.css?v=1677105736053" rel="stylesheet" />
<link href="assets/main.css?v=1677105536216" rel="stylesheet" media="screen, print"> <link href="assets/main.css?v=1677105736053" rel="stylesheet" media="screen, print">
<link href="assets/favicon.ico?v=1677105536216" rel="icon" type="image/x-icon"> <link href="assets/favicon.ico?v=1677105736053" rel="icon" type="image/x-icon">
<link href="assets/apple-touch-icon.png?v=1677105536216" rel="apple-touch-icon" sizes="180x180"> <link href="assets/apple-touch-icon.png?v=1677105736053" rel="apple-touch-icon" sizes="180x180">
<link href="assets/favicon-32x32.png?v=1677105536216" rel="icon" type="image/png" sizes="32x32"> <link href="assets/favicon-32x32.png?v=1677105736053" rel="icon" type="image/png" sizes="32x32">
<link href="assets/favicon-16x16.png?v=1677105536216" rel="icon" type="image/png" sizes="16x16"> <link href="assets/favicon-16x16.png?v=1677105736053" rel="icon" type="image/png" sizes="16x16">
</head> </head>
<body class="container-fluid"> <body class="container-fluid">
@ -928,6 +928,6 @@
</div> </div>
</div> </div>
<script src="assets/main.bundle.js?v=1677105536216"></script> <script src="assets/main.bundle.js?v=1677105736053"></script>
</body> </body>
</html> </html>

Write Preview
Loading…
Cancel
Save