From d433da0e6d39678d3794beba177a2d48b2d1636f Mon Sep 17 00:00:00 2001 From: Cristian Recoseanu Date: Tue, 28 May 2024 13:36:22 +0100 Subject: [PATCH] Clarify restore terminology --- docs/API requests.md | 6 +++--- docs/Backup & restore.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/API requests.md b/docs/API requests.md index f51b2ce..ed3ad57 100644 --- a/docs/API requests.md +++ b/docs/API requests.md @@ -138,11 +138,11 @@ The response MUST be of type [NcMethodResultObjectPropertiesSetValidation](https This is equivalent to invoking the `SetPropertiesByPath` method inside the [Bulk properties manager object](https://specs.amwa.tv/nmos-control-feature-sets/branches/publish-device-configuration/device-configuration/#ncbulkpropertiesmanager). -Setting properties through the `bulkProperties` endpoint allows a user to perform a `full restore`, a `partial restore` or a `selective restore`. +Setting properties through the `bulkProperties` endpoint allows a user to perform a `complete restore`, an `incomplete restore` or a `selective restore`. -A `complete restore` is when a [backup data set](Backup%20&%20restore.md#definitions) from a `full backup` is applied as a `PUT` to the `/bulkProperties` endpoint of the root block with the `recurse` argument set to true, and all the properties of all role paths in the data set are applied successfully (their returned validation status is `Ok`). A `complete restore` can also be achieved when a `partial backup` is applied and all the properties of all role paths in the data set are applied successfully (their returned validation status is `Ok`). If any of the properties return a validation status other than `Ok` then that is called an [incomplete restore](Backup%20&%20restore.md#definitions). +A `complete restore` is when a [full backup](Backup%20&%20restore.md#definitions) is applied as a `PUT` to the `/bulkProperties` endpoint of the root block with the `recurse` argument set to true, and all the properties of all role paths in the data set are applied successfully (their returned validation status is `Ok`). A `complete restore` can also be achieved when a [partial backup](Backup%20&%20restore.md#definitions) is applied and all the properties of all role paths in the data set are applied successfully (their returned validation status is `Ok`). If any of the properties return a validation status other than `Ok` then that is called an [incomplete restore](Backup%20&%20restore.md#definitions). -A `selective restore` is when a [backup data set](Backup%20&%20restore.md#definitions) from a `full backup` or `partial backup` is applied as a `PUT` to the `/bulkProperties` endpoint of a role path which is not the root block. A selective restore can also be achieved by a `PUT` operation to the `/bulkProperties` endpoint of the root block with the `recurse` query parameter set to false which will result in restoring the properties of the root block only. +A `selective restore` is when a [full backup](Backup%20&%20restore.md#definitions) or a [partial backup](Backup%20&%20restore.md#definitions) is applied as a `PUT` to the `/bulkProperties` endpoint of a role path which is not the root block. A selective restore can also be achieved by a `PUT` operation to the `/bulkProperties` endpoint of the root block with the `recurse` query parameter set to false which will result in restoring the properties of the root block only. ## PATCH diff --git a/docs/Backup & restore.md b/docs/Backup & restore.md index 0343034..1ec06b3 100644 --- a/docs/Backup & restore.md +++ b/docs/Backup & restore.md @@ -46,7 +46,7 @@ A `complete restore` is when all properties for all role paths in a `full backup An `incomplete restore` is when some properties of a `full backup` or `partial backup` are not successfully applied to a `device`. This might occur when a `backup data set` is restored to an `incompatible revision`. This is achieved by using the [/bulkProperties endpoint](https://specs.amwa.tv/is-14/branches/v1.0-dev/docs/API_requests.html#setting-bulk-properties-for-a-role-path). -A `selective restore` can be used to apply only selected parts of a `backup set` to a device. This is achieved by using the [/bulkProperties endpoint](https://specs.amwa.tv/is-14/branches/v1.0-dev/docs/API_requests.html#setting-bulk-properties-for-a-role-path). +A `selective restore` is when a subset of a `backup data set` is applied to a device. This is achieved by using the [/bulkProperties endpoint](https://specs.amwa.tv/is-14/branches/v1.0-dev/docs/API_requests.html#setting-bulk-properties-for-a-role-path). ## 1. Performing a backup