annotate scid/page-api-jobs.h @ 37:62aefd02ac59

make: remove config.mk
author David Demelier <markand@malikania.fr>
date Sun, 07 Aug 2022 08:41:06 +0200
parents 1d0ddf9e6efd
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
2 * page-api-jobs.h -- page /api/v?/jobs route
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_PAGE_API_JOBS_H
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_PAGE_API_JOBS_H
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
22 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
23 * \file page-api-jobs.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Page /api/v?/jobs route.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
25 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
26 * This module logs message with tag `page-api-jobs`.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
27 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
28
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct kreq;
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
31 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
32 * Run the page.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
33 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
34 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
35 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
36 */
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
38 page_api_v1_jobs(struct kreq *r);
23
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
2cb228f23f53 misc: rework todo/jobs HTTP requests
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 #endif /* !SCI_PAGE_API_JOBS_H */