Virtualization SDK Docs - New plugin config property snapshotParametersDefinition

docs/docs/References/Glossary.md

@@ -88,10 +88,10 @@ Information that represents a set of dependencies that a dataset requires in ord
 A formal description of a data type. Plugins use JSON format for their [schemas](Schemas_and_Autogenerated_Classes.md#schemas-and-autogenerated-classes).
 
 ## Snapshot
-A point-in-time read-only copy of a dataset. A snapshot includes associated metadata represented by the [SnapshotDefinition Schema](Schemas_and_Autogenerated_Classes.md#snapshotdefinition)
+A point-in-time read-only copy of a dataset. A snapshot includes associated metadata represented by the [SnapshotDefinition Schema](Schemas_and_Autogenerated_Classes.md#snapshotdefinition).
 
-## Snapshot Parameter
-User provided parameters for the snapshot operation. Currently the only properties the parameter has is resync.
+## Snapshot Parameters
+User provided parameters for the snapshot operation which can be defined in a [Snapshot Parameters Definition](Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition).
 
 ## Source Config
 A collection of information that the Delphix Engine needs to interact with a dataset (whether [linked](#linked-dataset) or [virtual](#virtual-dataset) on an [environment](#environment).

docs/docs/References/Schemas.md

@@ -22,6 +22,7 @@ Delphix Object | Schema | Autogenerated Class
 [Linked Source](Glossary.md#linked-source) | [LinkedSourceDefinition](Schemas_and_Autogenerated_Classes.md#linkedsourcedefinition-schema) | [LinkedSourceDefinition](Schemas_and_Autogenerated_Classes.md#linkedsourcedefinition-class)
 [Virtual Source](Glossary.md#virtual-source) | [VirtualSourceDefinition](Schemas_and_Autogenerated_Classes.md#virtualsourcedefinition-schema)| [VirtualSourceDefinition](Schemas_and_Autogenerated_Classes.md#virtualsourcedefinition-class)
 [Snapshot](Glossary.md#linked-source) | [SnapshotDefinition](Schemas_and_Autogenerated_Classes.md#snapshotdefinition-schema) | [SnapshotDefinition](Schemas_and_Autogenerated_Classes.md#snapshotdefinition-class)
+[Snapshot Parameters](Glossary.md#snapshot-parameters) | [SnapshotParametersDefinition](Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-schema) | [SnapshotParametersDefinition](Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-class)
 
 
 ## JSON Schemas

docs/docs/References/Schemas_and_Autogenerated_Classes.md

@@ -230,3 +230,40 @@ snapshot2.transaction_id = 1500
 # A snapshot that omits the optional "transaction_id" property
 snapshot3 = SnapshotDefinition(version="1.0.0")
 ```
+
+## SnapshotParametersDefinition
+
+Defines [Snapshot Parameters](Glossary.md#snapshot-parameters) for the snapshot operation.
+
+### SnapshotParametersDefinition Schema
+
+```json
+{
+  "type": "object",
+  "required": ["resync"],
+  "additionalProperties": false,
+  "properties": {
+    "resync": { "type": "boolean" }
+  }
+}
+```
+
+### SnapshotParametersDefinition Class
+
+Autogenerated based on the [Snapshot Parameters Definition Schema](#snapshotparametersdefinition-schema).
+
+```python
+class SnapshotParametersDefinition:
+
+  def __init__(self, resync):
+    self._inner_dict = { "resync": resync }
+```
+
+> To use the class:
+
+```python
+from generated.defintions import SnapshotParametersDefinition
+
+# Since "resync" is required, it must be specified when constructing the object
+snapshot_parameter_definition = SnapshotParametersDefinition(resync=True)
+```

docs/docs/Release_Notes/.pages

@@ -1,4 +1,5 @@
 arrange:
+  - 3.0.0
   - 2.1.0
   - 2.0.0
   - 1.0.0

docs/docs/Release_Notes/3.0.0/.pages

@@ -0,0 +1,3 @@
+arrange:
+  - 3.0.0.md
+  - 3.0.0_Breaking_Changes.md

docs/docs/Release_Notes/3.0.0/3.0.0.md

@@ -0,0 +1,12 @@
+# Release - v3.0.0
+
+To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#installation).
+
+## New & Improved
+* N/A <!--TBD-->
+
+## Breaking Changes
+
+* Added a new required schema [Snapshot Parameters Definition](/References/Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-schema).
+
+[**For more information and detailed steps to detect and make changes.**](/Release_Notes/3.0.0/3.0.0_Breaking_Changes#new-required-schema)

docs/docs/Release_Notes/3.0.0/3.0.0_Breaking_Changes.md

@@ -0,0 +1,36 @@
+# Breaking Changes - v.3.0.0
+
+## New required schema
+[Snapshot Parameters Definition](/References/Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-schema) allows plugin authors to define [Snapshot Parameters] which can be displayed to an end-user whenever a linked source snapshot is taken.
+
+### What is affected
+All plugins built with v2.0.0 or below will be affected. The [Schema](/References/Schemas) must contain a `snapshotParametersDefinition`.
+
+### How does it fail
+[dvp build](/References/CLI.md#build) will fail with the following error message if the [SnapshotParametersDefinition Schema](/References/Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-schema) is not added to the schema file:
+
+```bash
+$ dvp build
+Error: 'snapshotParametersDefinition' is a required property on ['required']
+
+Validation failed on /private/var/tmp/fp/schemas/schema.json.
+0 Warning(s). 1 Error(s)
+
+BUILD FAILED.
+```
+
+### How to fix it
+Add a [SnapshotParametersDefinition Schema](/References/Schemas_and_Autogenerated_Classes.md#snapshotparametersdefinition-schema) to the `schemaFile` defined in the [Plugin Config](/References/Plugin_Config).
+
+Example:
+```python
+"snapshotParametersDefinition": {
+    "additionalProperties": false,
+    "properties": {
+        "resync": {
+            "type": "boolean"
+        }
+    },
+    "type": "object"
+}
+```

docs/mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: Delphix Virtualization SDK 2.1.0
+site_name: Delphix Virtualization SDK 3.0.0
 theme:
   name: material
   custom_dir: 'material/'
@@ -10,8 +10,9 @@ theme:
   font:
     text: Helvetica Neue
     code: Ubuntu Mono
+  feature:
 
-copyright: Copyright © 2019 Delphix Corp.
+copyright: Copyright © 2021 Delphix Corp.
 
 google_analytics:
   - 'UA-35429885-3'