From 61eedac83c7cbff877282aa1b19cb111d830e7cd Mon Sep 17 00:00:00 2001 From: Chris Iverach-Brereton <59611394+civerachb-cpr@users.noreply.github.com> Date: Mon, 18 Dec 2023 17:44:45 -0500 Subject: [PATCH] Add docs for the new `restore` service, update the docs for the existing `import` service (#203) --- .../api_endpoints/mission_scheduler_api.mdx | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs_outdoornav_user_manual/api/api_endpoints/mission_scheduler_api.mdx b/docs_outdoornav_user_manual/api/api_endpoints/mission_scheduler_api.mdx index 2b6fd774..80a30da1 100644 --- a/docs_outdoornav_user_manual/api/api_endpoints/mission_scheduler_api.mdx +++ b/docs_outdoornav_user_manual/api/api_endpoints/mission_scheduler_api.mdx @@ -155,13 +155,13 @@ exists, the returned object will have a blank UUID. **Service Type:** [clearpath_mission_scheduler_msgs/srv/ImportData](definitions.mdx#scheduler-importdata) -**Description:** Import data exported by the `export_data` service. This will delete all schedules and replace the -database contents with the imported data. +**Description:** Import data exported by the `export_data` service. This will add new schedules to the database +but will not modify or delete any existing schedules. :::note -This service is intended to be used in combination with the `export_data` service to facilitate backups or -synchronizing schedules across multiple robots. +This service is intended to be used in combination with the `export_data` service to facilitate deploying new +schedules across multiple robots. ::: @@ -172,6 +172,20 @@ synchronizing schedules across multiple robots. **Description:** Remove the mission at a given position from a schedule, or remove all copies of a mission from a schedule +### mission_scheduler/restore + +**Service Type:** [cpr_mission_scheduler_msgs/srv/ImportData](definitions.mdx#scheduler-importdata) + +**Description:** Restore data exported by the `export_data` service. This will delete all schedules and replace the +database contents with the imported data. + +:::note + +This service is intended to be used in combination with the `export_data` service to facilitate backups or +synchronizing schedules across multiple robots. + +::: + ### mission_scheduler/update_schedule **Service Type:** [mission_scheduler/srv/UpdateSchedule](definitions.mdx#scheduler-updateschedule)