Updated GraphQL schema API files

Author: Matthieu Vachon

README.md

@@ -21,6 +21,35 @@ To start the hugo server, run this command:
 hugo server
 ```
 
+### GraphQL API Reference
+
+The GraphQL API Reference content is generated straight from the GraphQL schema of the different products
+we support.
+
+To update them, a pre-defined project layout on disk is expected by the script. You must have the three
+following project colocated as siblings alongside the `docs` project:
+
+- `docs`
+- `dfuse-eosio`
+- `dfuse-ethereum`
+
+The later two must be named verbatim, the first one `docs` could be named whatever you like. Once the
+following layout exist on your local workstation, to update the GraphQL generate API reference data,
+first install the script dependencies:
+
+```
+npm install
+```
+
+Then run the following command:
+
+```
+node graphql.js
+```
+
+This should update the file `data/eos/graphql.json` and `data/eth/graphql.json` (and any other
+chains we now support) if the GraphQL schema has been updated.
+
 ## Content Structure
 
 All content can be found in the `/content` directory. The structure of the website is generated automatically based on the structure of that directory.
@@ -62,7 +91,7 @@ For example the example snippet is from the file:
 └── ...
 ```
 
-When hugo builds the site, the code sections are extracted and stored in the `data` folder in project root. 
+When hugo builds the site, the code sections are extracted and stored in the `data` folder in project root.
 Example code can then be referenced with the following shortcode:
 ```go
 {{< code-section "quickstarts_javascript_node_eos_section1" >}}

data/eos/graphql.json

@@ -1814,15 +1814,15 @@
   {
     "name": "DBOp",
     "hideChildren": true,
-    "description": "Represents the mutation of a row, in a contract table.",
+    "description": "Represents the change delta of a row, in a contract table.\n\nThe `operation` field can be used to determine what happened\nto the row. Was is just inserted, modified or deleted?",
     "fields": [
       {
         "name": "operation",
         "type": {
           "reqType": true,
           "name": "DB_OPERATION"
         },
-        "description": "",
+        "description": "The `operation` type should be referred to when inspecting the `oldData`, `oldJSON`, `newData`, `newJSON`\nfields. The `operation`'s value will determine what those value will contain.\n\nAssume the following example fields values (for brievity and clarity, we show the `oldJSON`\nand the `newJSON` fields, but the concept applies equally to `oldData` and `newData` which\nare the Hexadecimal binary version of the JSON):\n\n```\n   { operation: \"INS\", newJSON: { \"id\":1, \"name\": \"john\" }, oldJSON: <nil> } }\n   { operation: UPD, newJSON: { \"id\":1, \"name\": \"johnny\"}, oldJSON: { \"id\":1, \"name\": \"john\" } }\n   { operation: REM, newJSON: <nil>, oldJSON: { \"id\":1, \"name\": \"johnny\" } }\n```\n\nWhen the `operation` type is `\"INS\"`, the `oldJSON` will be `null`, since it's a new row,\nit cannot have a previous state, the `newJSON` will be set with the new value just inserted.\n\nWhen the `operation` type is `\"UPD\"`, the `newJSON` will contain the new row's value after\nthe update while the `oldJSON` will be set with the value the row had before being updated.\n\nWhen the `operation` type is `\"REM\"`, the `newJSON` will be `null`, since it's a deleted row,\nno new state exists, the `oldJSON` will be set with the value the row had before being\ndeleted.",
         "arguments": []
       },
       {

data/eth/graphql.json

@@ -622,6 +622,14 @@
         },
         "description": "`signature` holds the V, R and S values representing the cryptographic signature for this transaction. It is based on these values that the `from` address is derived",
         "arguments": []
+      },
+      {
+        "name": "raw",
+        "type": {
+          "name": "String"
+        },
+        "description": "The raw signed transaction has sent to the network for inclusion into the chain. Can be null in circumstances where signed data was not recovered, for example when doing speculative execution from raw input parameters where signing data is not provided.",
+        "arguments": []
       }
     ]
   },
@@ -815,6 +823,14 @@
         "description": "`signature` holds the V, R and S values representing the cryptographic signature for this transaction. It is based on these values that the `from` address is derived",
         "arguments": []
       },
+      {
+        "name": "raw",
+        "type": {
+          "name": "String"
+        },
+        "description": "The raw signed transaction has sent to the network for inclusion into the chain. Can be null in circumstances where signed data was not recovered, for example when doing speculative execution from raw input parameters where signing data is not provided.",
+        "arguments": []
+      },
       {
         "name": "status",
         "type": {
@@ -1894,17 +1910,6 @@
         "description": "List of the block header of the uncles (ommers) of this block",
         "arguments": []
       },
-      {
-        "name": "uncles",
-        "type": {
-          "isList": true,
-          "reqList": true,
-          "reqType": true,
-          "name": "BlockHeader"
-        },
-        "description": "",
-        "arguments": []
-      },
       {
         "name": "transactionTraces",
         "type": {
@@ -2072,12 +2077,20 @@
         "description": "blockHeader is the block on which the transaction was speculatively executed",
         "arguments": []
       },
+      {
+        "name": "transaction",
+        "type": {
+          "name": "Transaction"
+        },
+        "description": "transaction holds the original transaction received from the Mempool that was used to speculatively execute the transaction.",
+        "arguments": []
+      },
       {
         "name": "trace",
         "type": {
           "name": "TransactionTrace"
         },
-        "description": "",
+        "description": "trace holds the speculative execution trace (includes all internal calls and theirs input/output, balance & state changes, etc).",
         "arguments": []
       }
     ]