Merge pull request #1041 from harrellbm/develop

Data mining Docs fixes and updates
2021-05-31 12:17:21 -04:00
commit d26ce4bde1
@@ -1,8 +1,8 @@
 {
    "type": "API Path Parameters",
    "definition": {
-        "text": "Path parameters are the type of parameters that are embedded as part of an URL path. They could be fixed string of texts or they could be a parameter that is replaced by the API Fetcher Bot for some value at runtime.",
-        "updated": 1621018106262
+        "text": "Path parameters are the type of parameters that are embedded as part of an URL path. They could be a fixed string of texts or they could be a parameter that is replaced by the API Fetcher Bot for some value at runtime.",
+        "updated": 1622336383876
    },
    "paragraphs": [
        {
@@ -1,8 +1,8 @@
 {
    "type": "API Query Responses",
    "definition": {
-        "text": "API calls producee responses. Under this section they are defined.",
-        "updated": 1621020920908
+        "text": "API calls produce responses. Under this section they are defined.",
+        "updated": 1622295146024
    },
    "paragraphs": [
        {
@@ -33,8 +33,8 @@
        },
        {
            "style": "Text",
-            "text": "In order to extract individual values for each Record Property, the API Data Fetcher Bot needs to dynamically discover the nodePath for each Record Propety at the response data structure and can do it as long as the API Response Field referenced is under the Data Root. To autodiscover the nodePath it uses the API Response Schame nodePath to locate the Data Root, and then it follows the reference from the API Response Field Reference node to the API Response Field and climb upwards until it reach the API Response Schema. While climbing upwards it discovers the nodePath that it needs to grabb the value from the response data structure. That is how it works.",
-            "updated": 1621972472491
+            "text": "In order to extract individual values for each Record Property, the API Data Fetcher Bot needs to dynamically discover the nodePath for each Record Propety at the response data structure and can do it as long as the API Response Field referenced is under the Data Root. To autodiscover the nodePath it uses the API Response Schema nodePath to locate the Data Root, and then it follows the reference from the API Response Field Reference node to the API Response Field and climbs upwards until it reach the API Response Schema. While climbing upwards it discovers the nodePath that it needs to grab the value from the response data structure. That is how it works.",
+            "updated": 1622372741883
        },
        {
            "style": "Text",
@@ -17,8 +17,8 @@
        },
        {
            "style": "List",
-            "text": "fieldType: This property declares if the data is number, a string an object or an array, those are the 4 possible values.",
-            "updated": 1621022104672
+            "text": "fieldType: This property declares if the data is number, a string, an object, or an array, those are the 4 possible values.",
+            "updated": 1622315306276
        },
        {
            "style": "List",
@@ -7,8 +7,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "The API Map assumes the API Server will respond with string formatted in JSON. This means that the response will be a data structure of nestled objects and arrays. Users will need to map the response format into a API Response Schema by adding children to this node and to this node's children. All these descendants are of the same Node Type API Response Field. ",
-            "updated": 1621952655717
+            "text": "The API Map assumes the API Server will respond with string formatted in JSON. This means that the response will be a data structure of nestled objects and arrays. Users will need to map the response format into an API Response Schema by adding children to this node and to this node's children. All these descendants are of the same Node Type API Response Field.",
+            "updated": 1622312357188
        },
        {
            "style": "Title",
@@ -7,8 +7,8 @@
    "paragraphs": [
        {
            "style": "Note",
-            "text": "We expect every API to have at leat one version.",
-            "updated": 1621951647515
+            "text": "We expect every API to have at least one version.",
+            "updated": 1622291417472
        },
        {
            "style": "Include",
@@ -60,7 +60,7 @@
        {
            "style": "Include",
            "text": "Superalgos->Topic->Data Mining - Fetching Data From APIs->Data Aggregation",
-            "updated": 1621974902589
+            "updated": 1622336877604
        }
    ]
 }
@@ -61,10 +61,14 @@
            "text": "There is a Workspace called API Data Fetcher Bot Demo with a simple working example of the previous steps you can use as a reference.",
            "updated": 1622230619069
        },
+        {
+            "style": "Block",
+            "text": "Data Aggregation",
+            "updated": 1622336997587
+        },
        {
            "style": "Title",
-            "text": "How Does Data Aggregation Work?",
-            "updated": 1622230634850
+            "text": "How Does Data Aggregation Work?"
        },
        {
            "style": "Text",
@@ -106,10 +110,14 @@
            "style": "List",
            "text": "Avg: This means that the average of all values found in the time range will be used as the value for the Record Proeprty."
        },
+        {
+            "style": "Block",
+            "text": "Step By Step",
+            "updated": 1622372437520
+        },
        {
            "style": "Title",
-            "text": "Step by Step Guide to Fetch Data from an API",
-            "updated": 1622231458352
+            "text": "Step by Step Guide to Fetch Data from an API"
        },
        {
            "style": "Text",
@@ -133,8 +141,8 @@
        },
        {
            "style": "List",
-            "text": "Step #4: Read the API's documentation, indentify the endpoints, what parameters they require and what data they will provide you.",
-            "updated": 1621976675920
+            "text": "Step #4: Read the API's documentation, indentify the endpoints, what parameters they require and what data they will provide you. Another helpful way to see how the api responds is by typing the api endpoint into your browser and looking at the raw output.",
+            "updated": 1622469791527
        },
        {
            "style": "List",
@@ -143,8 +151,8 @@
        },
        {
            "style": "List",
-            "text": "Step #6: Create an API Map node, and start mapping the documented API by adding children to it.",
-            "updated": 1621976688595
+            "text": "Step #6: Create an API Map node, and start mapping the documented API by adding children to it. Especially pay attention to unnamed arrays and objects that may wrap the data.",
+            "updated": 1622470221717
        },
        {
            "style": "List",
@@ -196,8 +204,13 @@
        },
        {
            "style": "List",
-            "text": "Step #17: Pay attention to the special case of the required timeStamp Record Property. Specifically because it might be pointing to the header of the API response. Read the docs of the API Response Field Reference node to set up the nodePath property if necessary.",
-            "updated": 1622232714229
+            "text": "Step #17: The timestamp record property is the only required property. It helps keep the records you save organized. Addtionally, the timestamp may live in the header of the API responce. Read the docs of the API Response Field Reference node to set up the nodePath property if necessary.",
+            "updated": 1622475120505
+        },
+        {
+            "style": "Note",
+            "text": "It is a good idea to make sure you get the api fetcher bot running and debugged before moving on to the next step.",
+            "updated": 1622475171484
        },
        {
            "style": "List",