doc: update documentation content

Author: kan-fu

.gitignore

@@ -150,3 +150,6 @@ dmypy.json
 
 # commit-msg hook
 commit-msg
+
+# Mac OS specfic
+.DS_Store

doc/source/Code_Examples/Discover_Data_Products.ipynb

@@ -32,7 +32,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions\n"
+    "## [/dataProducts](https://data.oceannetworks.ca/OpenAPI#get-/dataProducts)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Get all data products and their individual parameters from Oceans 3.0\n"
    ]
   },
   {
@@ -48,9 +55,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get the data product extensions for a specific data product code\n",
+    "### Get the data product options that are available for a specific data product code\n",
     "\n",
-    "Return all data product extensions for the _dataProductCode_ \"TSSD\" (\"Time Series Scalar Data\").\n"
+    "Return all data product options for the _dataProductCode_ \"**TSSD**\" (\"Time Series Scalar Data\").\n"
    ]
   },
   {
@@ -69,9 +76,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions available for a specific extension\n",
+    "### Get all data product options that are available with a specific file extension\n",
     "\n",
-    "Return all data product extensions which are available for the _extension_ \"pdf\".\n"
+    "Return all data product options which are available for the _extension_ \"**pdf**\".\n"
    ]
   },
   {
@@ -90,9 +97,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions available for a specific data product code and specific extension\n",
+    "### Get all data product options available for a specific data product code and specific file extension\n",
     "\n",
-    "Return all data product extensions which are available for the _dataProductCode_ \"TSSD\" and _extension_ \"csv\".\n"
+    "Return all data product options which are available for the _dataProductCode_ \"**TSSD**\" and _extension_ \"**csv**\".\n"
    ]
   },
   {
@@ -112,9 +119,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions which have a certain word in the name\n",
+    "### Get all data product options which have a certain word in the data product name\n",
     "\n",
-    "Return all data product extensions which have \"scalar\" in the name.\n"
+    "Return all data product options which have \"**scalar**\" in the name.\n"
    ]
   },
   {
@@ -133,9 +140,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions that are available at a specific location\n",
+    "### Get all data product options that are available at a specific location on ONCs network\n",
     "\n",
-    "Return all data product extensions that are available at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
+    "Return all data product options that are available at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
    ]
   },
   {
@@ -154,9 +161,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions that are available for a specific extension at a specific location\n",
+    "### Get all data product options that are available for a specific file extension at a specific locationCode\n",
     "\n",
-    "Return all data product extensions that are available for the _extension_ \"mat\" at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
+    "Return all data product options that are available for the _extension_ \"**mat**\" at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
    ]
   },
   {
@@ -176,9 +183,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product codes that are available on a specific deployed device\n",
+    "### Get all data products and their filter parameter options that are available on a specific deployed device\n",
     "\n",
-    "Return all data product codes available for a device with the _deviceCode_ \"NORTEKAQDPRO8398\".\n"
+    "Return all data product codes available for a device with the _deviceCode_ \"**NORTEKAQDPRO8398**\".\n"
    ]
   },
   {
@@ -197,30 +204,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all data product extensions with a specific property\n",
-    "\n",
-    "Return all data product extensions which have the property \"seawatertemperature\".\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "params = {\n",
-    "    \"propertyCode\": \"seawatertemperature\",\n",
-    "}\n",
-    "onc.getDataProducts(params)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Get all data product extensions that are available for a specific device category\n",
+    "### Get all data product options that are available for a specific device category\n",
     "\n",
-    "Return all data product extensions which are available for the _deviceCategoryCode_ \"ADCP 150 kHz\".\n"
+    "Return all data product options which are available for the _deviceCategoryCode_ \"**ADCP150KHZ**\".\n"
    ]
   },
   {
@@ -252,7 +238,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.10.12"
   },
   "mystnb": {
    "remove_code_outputs": true

doc/source/Code_Examples/Discover_Deployments.ipynb

@@ -9,7 +9,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -32,25 +32,16 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "onc.getDeployments()"
+    "## [/deployments](https://data.oceannetworks.ca/OpenAPI#get-/deployments)\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments for a specific device code\n",
+    "### Get all deployments for a specific device code\n",
     "\n",
-    "Return the deployments for the device with the _deviceCode_ \"NORTEKAQDPRO8398\".\n"
+    "Return the deployments for the device with the _deviceCode_ \"**NORTEKAQDPRO8398**\".\n"
    ]
   },
   {
@@ -69,9 +60,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments at a specific location\n",
+    "### Get all deployments at a specific location\n",
     "\n",
-    "Return all deployments at the location with the _locationCode_ \"BACAX\".\n"
+    "Return all deployments at the location with the _locationCode_ \"**BACAX**\".\n"
    ]
   },
   {
@@ -90,9 +81,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments with a specific device category\n",
+    "### Get all deployments with a specific device category\n",
     "\n",
-    "Return all deployments with the _deviceCategoryCode_ \"ADCP2MHZ\".\n"
+    "Return all deployments with the _deviceCategoryCode_ \"**ADCP2MHZ**\".\n"
    ]
   },
   {
@@ -111,9 +102,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments with a specific property\n",
+    "### Get all deployments with a specific property\n",
     "\n",
-    "Return all deployments with instruments that measure the property \"oxygen\".\n"
+    "Return all deployments with instruments that measure the property \"**oxygen**\".\n"
    ]
   },
   {
@@ -132,9 +123,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments with a specific device category and a specific property\n",
+    "### Get all deployments with a specific device category and a specific property\n",
     "\n",
-    "Return all deployments that have devices with the device category \"CTD\" and property \"pressure\".\n"
+    "Return all deployments that have devices with the device category \"**CTD**\" and property \"**pressure**\".\n"
    ]
   },
   {
@@ -154,7 +145,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments between two dates\n",
+    "### Get all deployments between two dates\n",
     "\n",
     "Return all deployments between 1 July 2010 and 30 June 2011. Check [here](https://wiki.oceannetworks.ca/display/O2A/Glossary+of+Terms#GlossaryofTerms-ISO8601Duration) for additional information about the supported dates/times format.\n"
    ]
@@ -176,9 +167,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments at a specific location, between two dates\n",
+    "### Get all deployments at a specific location, between two dates\n",
     "\n",
-    "Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"BACAX\" (\"Barkely Canyon Axis (POD1)\").\n"
+    "Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"**BACAX**\" (\"Barkely Canyon Axis (POD1)\").\n"
    ]
   },
   {
@@ -199,9 +190,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all deployments at a specific location, between two dates, with a sensor with a specific property code\n",
+    "### Get all deployments at a specific location, between two dates, with a sensor with a specific property code\n",
     "\n",
-    "Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"BACAX\" (\"Barkely Canyon Axis (POD1)\"), with the _propertyCode_ \"seawatertemperature\".\n"
+    "Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"**BACAX**\" (\"Barkely Canyon Axis (POD1)\"), with the _propertyCode_ \"**seawatertemperature**\".\n"
    ]
   },
   {
@@ -236,7 +227,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.10.12"
   },
   "mystnb": {
    "remove_code_outputs": true

doc/source/Code_Examples/Discover_Device_Categories.ipynb

@@ -32,7 +32,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all device categories\n"
+    "## [/deviceCategories](https://data.oceannetworks.ca/OpenAPI#get-/deviceCategories)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Get all device categories\n"
    ]
   },
   {
@@ -48,9 +55,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get the device category for a specific device category code\n",
+    "### Get the device category for a specific device category code\n",
     "\n",
-    "Return the device category for the _deviceCategoryCode_ \"ADCP150KHZ\".\n"
+    "Return the device category information for the _deviceCategoryCode_ \"**ADCP150KHZ**\".\n"
    ]
   },
   {
@@ -69,9 +76,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all device categories which have a certain word in the name\n",
+    "### Get all device categories which have a certain word in the name\n",
     "\n",
-    "Return all device categories which have \"acoustic\" in the name.\n"
+    "Return all device categories which have \"**acoustic**\" in the name.\n"
    ]
   },
   {
@@ -90,9 +97,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all device categories which have a certain word in the description\n",
+    "### Get all device categories which have a certain word in the description\n",
     "\n",
-    "Return all device categories which have \"doppler\" in the description.\n"
+    "Return all device categories which have \"**doppler**\" in the description.\n"
    ]
   },
   {
@@ -111,9 +118,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all device categories that are available at a specific location\n",
+    "### Get all device categories that are available at a specific location\n",
     "\n",
-    "Return all device categories that are available at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
+    "Return all device categories that are available at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
    ]
   },
   {
@@ -132,9 +139,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Get all the device categories which have devices that have a specific property\n",
+    "### Get all the device categories which have devices that have a specific property\n",
     "\n",
-    "Return all device categories which have devices with the property \"salinity\".\n"
+    "Return all device categories which have devices with the propertyCode \"**salinity**\".\n"
    ]
   },
   {
@@ -166,7 +173,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.11.7"
   },
   "mystnb": {
    "remove_code_outputs": true