plugin.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "jupyter-fs",
  "description": "Settings for the jupyter-fs extension.",
  "jupyter.lab.setting-icon": "jfs:drive",
  "jupyter.lab.setting-icon-label": "jupyter-fs",
  "type": "object",
  "additionalProperties": false,

  "definitions": {
    "resource": {
      "description": "Specification for an fs resource",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "description": "Display name of resource",
          "type": "string"
        },
        "url": {
          "description": "A url pointing to an fs resource, as per the PyFilesystem fsurl specification",
          "type": "string"
        },
        "auth": {
          "description": "Given any template {{VARS}} in the url, 'ask' (default) to open a dialog box asking for credentials, or `env` to pick up credentials from the server's environment variables",
          "type": "string",
          "enum": ["ask", "env", false],
          "default": "ask"
        }
      }
    }
  },

  "properties": {
    "resources": {
      "description": "The list of fs resource specifications",
      "items": { "$ref": "#/definitions/resource" },
      "type": "array",
      "default": []
    },
    "options": {
      "description": "Global options for jupyter-fs",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cache": {
          "description": "If true, only recreate the actual resources when necessary (ie on initial load or changes to 'resources')",
          "type": "boolean",
          "default": true
        },
        "verbose": {
          "description": "If true, jupyter-fs will output helpful info messages to the console",
          "type": "boolean",
          "default": false
        }
      },
      "default": {}
    }
  }
}