Initial API Map and Mine docs edited and complete

2021-06-05 07:43:54 -05:00
1 parent ebe64b7f8e
commit cdb945b99b
@@ -5,9 +5,14 @@
        "updated": 1621954996474
    },
    "paragraphs": [
+        {
+            "style": "Note",
+            "text": "For developers: When reading through the code you should notice extensive use of the TS object. The TS object  is the root object of a data structure available at runtime within the Task Server.",
+            "updated": 1622896987189
+        },
        {
            "style": "Text",
-            "text": "Right click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode. Then you can use docs.save to save your changes and app.contribute to send it to the main repository."
+            "text": "For a description of how to debug a task being run on the task server please see the Debugging a Task page."
        }
    ]
 }
@@ -7,7 +7,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "Right click and select the pencil button to enter edit mode."
+            "text": "Please see the API Data Fetcher Bot page for a more indepth description of how this bot works.",
+            "updated": 1622896001076
        }
    ]
 }
@@ -1,14 +1,14 @@
 {
    "type": "API Data Fetcher Bot",
    "definition": {
-        "text": "It is a type of bot that can fetch data from any API on the internet as long as it is provided with a API Map at runtime.",
-        "updated": 1621022644745
+        "text": "This bot can fetch data from any API on the internet as long as it is provided with an API Map at runtime.",
+        "updated": 1622895037822
    },
    "paragraphs": [
        {
            "style": "Text",
-            "text": "An API Data Fetcher Bots is similar to a Sensor Bot, except that the second need dev users to code an algo for extracting the data, while the first one can do it without coding, just using an API Map.",
-            "updated": 1621969800744
+            "text": "An API Data Fetcher Bot is similar to a Sensor Bot, except that a Sensor Bot requires a dev users to code an algorithm to extract the data, while an API Data Fetcher Bot can do it without coding using an API Map.",
+            "updated": 1622895168429
        },
        {
            "style": "Include",
@@ -21,7 +21,18 @@
        },
        {
            "style": "Title",
-            "text": "Configuration"
+            "text": "API Data Fetcher Bot Configuration",
+            "updated": 1622895379480
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties",
+            "updated": 1622895415959
+        },
+        {
+            "style": "List",
+            "text": "codeName Define the name of the bot that will be used in the code.",
+            "updated": 1622895425847
        }
    ]
 }
@@ -7,7 +7,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "Right click and select the pencil button to enter edit mode."
+            "text": "Please see the Process Definition page for a more indepth description of what a process is and how it works.",
+            "updated": 1622896365184
        }
    ]
 }
@@ -26,8 +26,12 @@
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863183444
+            "text": "API Endpoint Configuration",
+            "updated": 1622895671396
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -1,14 +1,18 @@
 {
    "type": "API Map Reference",
    "definition": {
-        "text": "This node allows users to define a reference to an API Map, so that when the bot is ran, it uses that API Map to exctract data from.",
-        "updated": 1621023375333
+        "text": "This node allows users to define a reference to an API Map. When the bot is run, it will use the referenced API Map to extract data from the API.",
+        "updated": 1622896481536
    },
    "paragraphs": [
        {
            "style": "Important",
-            "text": "For this node to be correctly installed and a reference stablished to the API Data Mine by the Install New Market procedure, both the Data Mine and the API Data Map needs to have exactly the same config property codeName, otherwise, this node will be created but you will have to stablish the reference manually.",
-            "updated": 1622472653778
+            "text": "For this node to be correctly installed and a reference established to the API Data Mine using the Install New Market procedure, both the Data Mine and the API Data Map needs to have exactly the same config property codeName, otherwise, this node will be created but you will have to establish the reference manually.",
+            "updated": 1622896540326
+        },
+        {
+            "style": "Text",
+            "text": "For a more indepth description of what an API Map is please see the API Map page."
        }
    ]
 }
@@ -165,30 +165,37 @@
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863551147
+            "text": "API Map Configuration",
+            "updated": 1622895474056
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
-            "text": "codeName: this must be the same codeName as the Data Mine codeName in order for the Install New Market procedure to link them properly at the API Map Reference node.",
-            "updated": 1622472871204
+            "text": "codeName: this must be the same codename as the Data Mine codename in order for the Install New Market procedure to link them properly at the API Map Reference node.",
+            "updated": 1622895563618
        },
        {
            "style": "List",
-            "text": "protocol: the protocol to be used to access the API. For now either http or https."
+            "text": "protocol: the protocol to be used to access the API. For now either http or https.",
+            "updated": 1622895574503
        },
        {
            "style": "List",
-            "text": "portNumber: the port at which the API server is listening."
+            "text": "portNumber: the port at which the API server is listening.",
+            "updated": 1622895581034
        },
        {
            "style": "List",
-            "text": "hostName: the domain name or IP address of the API server."
+            "text": "hostName: the domain name or IP address of the API server.",
+            "updated": 1622895586641
        },
        {
            "style": "List",
            "text": "path: the URL path to where the API is located within the remote server.",
-            "updated": 1621016495461
+            "updated": 1622895592146
        },
        {
            "style": "List",
@@ -12,8 +12,12 @@
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622772725049
+            "text": "API Path Parameter Configuration",
+            "updated": 1622895766034
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -12,8 +12,12 @@
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863199996
+            "text": "API Query Parameter Configuration",
+            "updated": 1622895734675
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -7,8 +7,12 @@
    "paragraphs": [
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863221142
+            "text": "API Query Response Configuration",
+            "updated": 1622895797460
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -7,8 +7,12 @@
    "paragraphs": [
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622864255383
+            "text": "API Response Field Configuration",
+            "updated": 1622895885768
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -10,15 +10,33 @@
            "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": "Text",
+            "text": "Here is an example of an API's response JSON:",
+            "updated": 1622894576735
+        },
+        {
+            "style": "Json",
+            "text": "{\n    \"status\": {\n        \"timestamp\": \"2018-06-02T22:51:28.209Z\",\n         \"elapsed\": 10\n    },\n    \"data\": [\n        {\n        \"id\": \"1e31218a-e44e-4285-820c-8282ee222035\",\n        \"symbol\": \"BTC\",\n        \"name\": \"Bitcoin\",\n        \"slug\": \"bitcoin\",\n        \"profile\": {...},\n        \"metrics\": {...}\n        }\n    ]\n}",
+            "updated": 1622894444830
+        },
+        {
+            "style": "Text",
+            "text": "The main object is the first set of curly brackets { } enclosing everything. As you can see, underneath that there are two object properties named status and data. Status is an object and contains the header information. Data is an array and holds the actual data we are after. As you API Response Field nodes to your API Response Schema node you will be mapping an API response similar to this one.",
+            "updated": 1622894937351
+        },
        {
            "style": "Success",
-            "text": "When reading documentation, or looking at raw data held in JSON, it is important to remember that curly brackets { } define objects while square brackets [ ] define arrays.",
-            "updated": 1622863958740
+            "text": "When reading documentation, or looking at raw data held in JSON, it is important to remember that curly brackets { } define objects while square brackets [ ] define arrays."
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863966010
+            "text": "API Response Schema Configuration",
+            "updated": 1622895860644
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",
@@ -17,8 +17,12 @@
        },
        {
            "style": "Title",
-            "text": "Configuration Properties",
-            "updated": 1622863171533
+            "text": "API Version Configuration",
+            "updated": 1622895641428
+        },
+        {
+            "style": "Subtitle",
+            "text": "Properties"
        },
        {
            "style": "List",