Introduce definitions and simplify structure #11
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
cristian-recoseanu
commented
May 14, 2024
•
cristian-recoseanu
commented
- removal of property traits
- introduction of restore modes
- document two restore scenarios for fixed/dynamic devices
- introduce the rebuildable concept
- update relevant diagrams
Remove normative language Co-authored-by: jonathan-r-thorpe <[email protected]>
Remove normative language Co-authored-by: jonathan-r-thorpe <[email protected]>
…AMWA-TV/is-14 into publish-backup-restore-revision
Remove normative language Co-authored-by: jonathan-r-thorpe <[email protected]>
Fix type for "selective"
- complete / incomplete restore are statuses/outcomes - selective restore is a user choice/action
to change text to use "Incomplete restore"
Remove allowPartial as it is not an argument for validation.
Remove examples reference
To mention property exceptions have to be returned when validating or restoring and the status returned is 206
by - reducing definitions - adding a General concepts section - refocusing the scenarios described on actual possible user scenarios (starting with one and more to be added later)
To be more generic in the use of validation fingerprint.
We're proposing the following changes:
- changing NcObjectPropertiesSetValidation: exceptions to "notices"
- changing NcPropertyRestoreException to NcPropertyRestoreNotice
- adding an enum NcPropertyRestoreNoticeType = { Warning, Error } which means adding the NcPropertyRestoreNotice: noticeType property
- removing NcRestoreValidationStatus: PartiallyOk
- changing NcRestoreValidationStatus: InvalidData to "Failed"
- removing NcRestoreValidationStatus: MissingDependency as these are now reported at property level using notices
- removal of propertyTraits - introduction of restoreMode - document two restore scenarios for fixed/dynamic devices - update relevant diagrams
To swap dynamic/fixed scenarios around as some of the diagrams are specific to the dynamic scenario
Comment on lines
+86
to
+90
| Retrieving properties through the `bulkProperties` endpoint allows a user to perform a `full backup` or a `partial backup`. | ||
|
|
||
| A `full backup` is a [backup data set](Backup%20&%20restore.md#definitions) returned by a `GET` operation on the `/bulkProperties` endpoint of the root block with the `recurse` parameter set to true. | ||
|
|
||
| A `partial backup` is a [backup data set](Backup%20&%20restore.md#definitions) returned by a `GET` operation on the `/bulkProperties` endpoint of any object of the device model, other than the root block. A partial backup can also be obtained by a `GET` operation on the `/bulkProperties` endpoint of the root block with the `recurse` query parameter set to false; however this will only result in a backup of the root block only. |
There was a problem hiding this comment.
Full backup and partial backup are redefined in the Backup and Restore document. Can they be deleted here?
There was a problem hiding this comment.
I think we struggled a bit with this. In this document the backup is explained with regards to how it is achieved by interacting with the API whereas in the other document it is explained with regards to the contents of the backup data set. They both link to each other. I don't think we can remove one or the other without moving that part of the explanation as well?
Add PR review suggestion Co-authored-by: jonathan-r-thorpe <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.