view scid/page-api-jobs.h @ 60:3804a2ab60ec

misc: documentation improvements
author David Demelier <markand@malikania.fr>
date Thu, 18 Aug 2022 10:12:54 +0200
parents 1d0ddf9e6efd
children 71cd8447e3a4
line wrap: on
line source

/*
 * page-api-jobs.h -- page /api/v?/jobs route
 *
 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef SCI_PAGE_API_JOBS_H
#define SCI_PAGE_API_JOBS_H

/**
 * \file page-api-jobs.h
 * \brief Page /api/v?/jobs route.
 *
 * This module logs message with tag `page-api-jobs`.
 */

struct kreq;

/**
 * Run the page.
 *
 * \pre r != NULL
 * \param r the request
 */
void
page_api_v1_jobs(struct kreq *r);

#endif /* !SCI_PAGE_API_JOBS_H */