API documentation - improving example for snapshot history

pull/1430/head
dgtlmoon 2 years ago
parent 3e98c8ae4b
commit c747cf7ba8

@ -133,6 +133,11 @@ class WatchHistory(Resource):
@apiDescription Requires `uuid`, returns list @apiDescription Requires `uuid`, returns list
@apiExample {curl} Example usage: @apiExample {curl} Example usage:
curl http://localhost:4000/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history -H"x-api-key:813031b16330fe25e3780cf0325daa45" -H "Content-Type: application/json" curl http://localhost:4000/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history -H"x-api-key:813031b16330fe25e3780cf0325daa45" -H "Content-Type: application/json"
{
"1676649279": "/tmp/data/6a4b7d5c-fee4-4616-9f43-4ac97046b595/cb7e9be8258368262246910e6a2a4c30.txt",
"1677092785": "/tmp/data/6a4b7d5c-fee4-4616-9f43-4ac97046b595/e20db368d6fc633e34f559ff67bb4044.txt",
"1677103794": "/tmp/data/6a4b7d5c-fee4-4616-9f43-4ac97046b595/02efdd37dacdae96554a8cc85dc9c945.txt"
}
@apiName Get list of available stored snapshots for watch @apiName Get list of available stored snapshots for watch
@apiGroup Watch History @apiGroup Watch History
@apiSuccess (200) {String} OK @apiSuccess (200) {String} OK

File diff suppressed because one or more lines are too long

@ -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=1677105273196" rel="stylesheet" media="screen"> <link href="assets/bootstrap.min.css?v=1677105536216" rel="stylesheet" media="screen">
<link href="assets/prism.css?v=1677105273196" rel="stylesheet" /> <link href="assets/prism.css?v=1677105536216" rel="stylesheet" />
<link href="assets/main.css?v=1677105273196" rel="stylesheet" media="screen, print"> <link href="assets/main.css?v=1677105536216" rel="stylesheet" media="screen, print">
<link href="assets/favicon.ico?v=1677105273196" rel="icon" type="image/x-icon"> <link href="assets/favicon.ico?v=1677105536216" rel="icon" type="image/x-icon">
<link href="assets/apple-touch-icon.png?v=1677105273196" rel="apple-touch-icon" sizes="180x180"> <link href="assets/apple-touch-icon.png?v=1677105536216" rel="apple-touch-icon" sizes="180x180">
<link href="assets/favicon-32x32.png?v=1677105273196" rel="icon" type="image/png" sizes="32x32"> <link href="assets/favicon-32x32.png?v=1677105536216" rel="icon" type="image/png" sizes="32x32">
<link href="assets/favicon-16x16.png?v=1677105273196" rel="icon" type="image/png" sizes="16x16"> <link href="assets/favicon-16x16.png?v=1677105536216" 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=1677105273196"></script> <script src="assets/main.bundle.js?v=1677105536216"></script>
</body> </body>
</html> </html>

Loading…
Cancel
Save