chore: update JSON schema docs (#2588)

Co-authored-by: Linwei Shang <linwei.shang@dfinity.org>
dfinity · Sep 21, 2022 · 44004c4 · 44004c4
1 parent a32ae7a
commit 44004c4
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 4 deletions.
diff --git a/docs/dfx-json-schema.json b/docs/dfx-json-schema.json
@@ -192,7 +192,7 @@
             },
             "candid": {
               "title": "Candid File",
-              "description": "Path to this canister's candid interface declaration.",
+              "description": "Path to this canister's candid interface declaration.  A URL to a candid file is also acceptable.",
               "type": "string"
             },
             "type": {
@@ -203,7 +203,7 @@
             },
             "wasm": {
               "title": "WASM Path",
-              "description": "Path to WASM to be installed.",
+              "description": "Path to WASM to be installed. URLs to a WASM module are also acceptable.",
               "type": "string"
             }
           }
@@ -312,6 +312,12 @@
               "type": "null"
             }
           ]
+        },
+        "shrink": {
+          "title": "Shrink Canister WASM",
+          "description": "Whether run `ic-wasm shrink` after building the Canister. Default is true.",
+          "default": true,
+          "type": "boolean"
         }
       }
     },
@@ -482,15 +488,36 @@
       "properties": {
         "enabled": {
           "title": "Enable HTTP Adapter",
-          "default": false,
+          "default": true,
           "type": "boolean"
+        },
+        "log_level": {
+          "title": "Logging Level",
+          "description": "The logging level of the adapter.",
+          "default": "error",
+          "allOf": [
+            {
+              "$ref": "#/definitions/HttpAdapterLogLevel"
+            }
+          ]
         }
       }
     },
     "ConfigDefaultsReplica": {
       "title": "Local Replica Configuration",
       "type": "object",
       "properties": {
+        "log_level": {
+          "description": "Run replica with the provided log level. Default is 'error'. Debug prints still get displayed",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ReplicaLogLevel"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "port": {
           "description": "Port the replica listens on.",
           "type": [
@@ -611,6 +638,18 @@
         }
       }
     },
+    "HttpAdapterLogLevel": {
+      "description": "Represents the log level of the HTTP adapter.",
+      "type": "string",
+      "enum": [
+        "critical",
+        "error",
+        "warning",
+        "info",
+        "debug",
+        "trace"
+      ]
+    },
     "InitializationValues": {
       "title": "Initial Resource Allocations",
       "type": "object",
@@ -671,6 +710,17 @@
         "Release"
       ]
     },
+    "ReplicaLogLevel": {
+      "type": "string",
+      "enum": [
+        "critical",
+        "error",
+        "warning",
+        "info",
+        "debug",
+        "trace"
+      ]
+    },
     "ReplicaSubnetType": {
       "type": "string",
       "enum": [

diff --git a/docs/networks-json-schema.json b/docs/networks-json-schema.json
@@ -83,15 +83,36 @@
       "properties": {
         "enabled": {
           "title": "Enable HTTP Adapter",
-          "default": false,
+          "default": true,
           "type": "boolean"
+        },
+        "log_level": {
+          "title": "Logging Level",
+          "description": "The logging level of the adapter.",
+          "default": "error",
+          "allOf": [
+            {
+              "$ref": "#/definitions/HttpAdapterLogLevel"
+            }
+          ]
         }
       }
     },
     "ConfigDefaultsReplica": {
       "title": "Local Replica Configuration",
       "type": "object",
       "properties": {
+        "log_level": {
+          "description": "Run replica with the provided log level. Default is 'error'. Debug prints still get displayed",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ReplicaLogLevel"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "port": {
           "description": "Port the replica listens on.",
           "type": [
@@ -212,6 +233,18 @@
         }
       }
     },
+    "HttpAdapterLogLevel": {
+      "description": "Represents the log level of the HTTP adapter.",
+      "type": "string",
+      "enum": [
+        "critical",
+        "error",
+        "warning",
+        "info",
+        "debug",
+        "trace"
+      ]
+    },
     "NetworkType": {
       "title": "Network Type",
       "description": "Type 'ephemeral' is used for networks that are regularly reset. Type 'persistent' is used for networks that last for a long time and where it is preferred that canister IDs get stored in source control.",
@@ -221,6 +254,17 @@
         "persistent"
       ]
     },
+    "ReplicaLogLevel": {
+      "type": "string",
+      "enum": [
+        "critical",
+        "error",
+        "warning",
+        "info",
+        "debug",
+        "trace"
+      ]
+    },
     "ReplicaSubnetType": {
       "type": "string",
       "enum": [