Skip to content

chore: update JSON schema docs #2588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lwshang merged 2 commits into from
Sep 21, 2022
Merged

chore: update JSON schema docs #2588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a123af8
chore: update JSON schema docs
Sep 20, 2022
ac23770
Merge branch 'master' into update-docs
lwshang Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 53 additions & 3 deletions docs/dfx-json-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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"
}
}
Expand Down Expand Up @@ -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"
}
}
},
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -671,6 +710,17 @@
"Release"
]
},
"ReplicaLogLevel": {
"type": "string",
"enum": [
"critical",
"error",
"warning",
"info",
"debug",
"trace"
]
},
"ReplicaSubnetType": {
"type": "string",
"enum": [
Expand Down
46 changes: 45 additions & 1 deletion docs/networks-json-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -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.",
Expand All @@ -221,6 +254,17 @@
"persistent"
]
},
"ReplicaLogLevel": {
"type": "string",
"enum": [
"critical",
"error",
"warning",
"info",
"debug",
"trace"
]
},
"ReplicaSubnetType": {
"type": "string",
"enum": [
Expand Down