mirror of
https://github.com/scottlamb/moonfire-nvr.git
synced 2025-11-07 12:52:58 -05:00
config file reference and doc reorganization
This commit is contained in:
@@ -60,7 +60,7 @@ message DirMeta {
|
||||
Open in_progress_open = 4;
|
||||
}
|
||||
|
||||
// Permissions to perform actions. See description in design/api.md.
|
||||
// Permissions to perform actions. See description in ref/api.md.
|
||||
//
|
||||
// This protobuf form is stored in user and session rows.
|
||||
message Permissions {
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
// SPDX-License-Identifier: GPL-v3.0-or-later WITH GPL-3.0-linking-exception.
|
||||
|
||||
//! Runtime configuration file (`/etc/moonfire-nvr.toml`).
|
||||
//! See `ref/config.md` for more description.
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ impl Session {
|
||||
}
|
||||
|
||||
/// JSON serialization wrapper for a single camera when processing `/api/` and
|
||||
/// `/api/cameras/<uuid>/`. See `design/api.md` for details.
|
||||
/// `/api/cameras/<uuid>/`. See `ref/api.md` for details.
|
||||
#[derive(Debug, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Camera<'a> {
|
||||
|
||||
@@ -230,7 +230,7 @@ fn num<'a, T: FromStr>() -> impl FnMut(&'a str) -> IResult<&'a str, T> {
|
||||
}
|
||||
|
||||
impl Segments {
|
||||
/// Parses the `s` query parameter to `view.mp4` as described in `design/api.md`.
|
||||
/// Parses the `s` query parameter to `view.mp4` as described in `ref/api.md`.
|
||||
/// Doesn't do any validation.
|
||||
fn parse(i: &str) -> IResult<&str, Segments> {
|
||||
// Parse START_ID[-END_ID] into Range<i32>.
|
||||
|
||||
Reference in New Issue
Block a user