From 8c591e724838443cceae5fe350bbcf241ba3c315 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 11 Oct 2017 17:05:01 -0400 Subject: [PATCH] Fixed up reports documentation --- docs/miscellaneous/reports.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/miscellaneous/reports.md b/docs/miscellaneous/reports.md index 79e4fb085..c6369283c 100644 --- a/docs/miscellaneous/reports.md +++ b/docs/miscellaneous/reports.md @@ -12,7 +12,7 @@ A NetBox report is a mechanism for validating the integrity of data within NetBo ## Writing Reports -Reports must be saved as files in the `netbox/reports/` path within the NetBox installation path. Each file created within this path is considered a separate module. Each module holds one or more reports, each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test. +Reports must be saved as files in the [`REPORTS_ROOT`](../configuration/optional-settings/#reports_root) path (which defaults to `netbox/reports/`). Each file created within this path is considered a separate module. Each module holds one or more reports (Python classes), each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test. !!! warning The reports path includes a file named `__init__.py`, which registers the path as a Python module. Do not delete this file. @@ -106,14 +106,14 @@ Once a report has been run, its associated results will be included in the repor ### Via the API -To run a report via the API, simply issue a POST request. Reports are identified by their module and class name. +To run a report via the API, simply issue a POST request to its `run` endpoint. Reports are identified by their module and class name. ``` - POST /api/extras/reports/./ + POST /api/extras/reports/./run/ ``` Our example report above would be called as: ``` - POST /api/extras/reports/devices.DeviceConnectionsReport/ + POST /api/extras/reports/devices.DeviceConnectionsReport/run/ ```