Share feedback
Answers are generated based on the documentation.

Experimental

Schema

FileInfo

Type: object

FileInfo is file metadata.
isDir

Type: boolean

is_dir reports whether the path is a directory and stays populated on every backend and every caller. type is the richer authority, and type == directory iff is_dir.
All schema constraints and annotations
{
  "description": "is_dir reports whether the path is a directory and stays populated on\nevery backend and every caller. type is the richer authority, and\ntype == directory iff is_dir.",
  "type": "boolean"
}
linkTarget

Type: string

link_target is the literal readlink() text when type is symlink, since that is the only case where nothing else lets the caller learn what the link names; empty otherwise.
All schema constraints and annotations
{
  "description": "link_target is the literal readlink() text when type is symlink,\nsince that is the only case where nothing else lets the caller learn what\nthe link names; empty otherwise.",
  "type": "string"
}
mode

Type: integer

mode is the stored Unix permission bits (0777), without type or special bits.
All schema constraints and annotations
{
  "description": "mode is the stored Unix permission bits (0777), without type or special bits.",
  "type": "integer"
}
path

Type: string

path is the sandbox path.
All schema constraints and annotations
{
  "description": "path is the sandbox path.",
  "type": "string"
}
size

Type: integer | string

size is the file size in bytes.
All schema constraints and annotations
{
  "description": "size is the file size in bytes.",
  "format": "int64",
  "type": [
    "integer",
    "string"
  ]
}
type

Schema: FileType

type classifies the object, and Stat and List populate it for every caller. Stat and List resolve an in-jail symlink and report the resolved target's type; a link that cannot be resolved in-jail (dangling, looping, or escaping) reports symlink for itself rather than disclosing an out-of-jail target.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/FileType",
  "description": "type classifies the object, and Stat and List populate it for every\ncaller. Stat and List resolve an in-jail symlink and report\nthe resolved target's type; a link that cannot be resolved in-jail\n(dangling, looping, or escaping) reports symlink for itself\nrather than disclosing an out-of-jail target."
}
All schema constraints and annotations
{
  "description": "FileInfo is file metadata.",
  "properties": {
    "isDir": {
      "description": "is_dir reports whether the path is a directory and stays populated on\nevery backend and every caller. type is the richer authority, and\ntype == directory iff is_dir.",
      "type": "boolean"
    },
    "linkTarget": {
      "description": "link_target is the literal readlink() text when type is symlink,\nsince that is the only case where nothing else lets the caller learn what\nthe link names; empty otherwise.",
      "type": "string"
    },
    "mode": {
      "description": "mode is the stored Unix permission bits (0777), without type or special bits.",
      "type": "integer"
    },
    "path": {
      "description": "path is the sandbox path.",
      "type": "string"
    },
    "size": {
      "description": "size is the file size in bytes.",
      "format": "int64",
      "type": [
        "integer",
        "string"
      ]
    },
    "type": {
      "$ref": "#/components/schemas/FileType",
      "description": "type classifies the object, and Stat and List populate it for every\ncaller. Stat and List resolve an in-jail symlink and report\nthe resolved target's type; a link that cannot be resolved in-jail\n(dangling, looping, or escaping) reports symlink for itself\nrather than disclosing an out-of-jail target."
    }
  },
  "title": "FileInfo",
  "type": "object"
}