PostFilesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/canonical/main/json-schema/canonical-post-files-response-schema.json",
  "title": "PostFilesResponse",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canonical-files-api-openapi.yml#/components/schemas/PostFilesResponse",
  "allOf": [
    {
      "$ref": "#/$defs/BaseResponse"
    },
    {
      "type": "object",
      "description": "JSON metadata about the file read operation.",
      "properties": {
        "result": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/fileResult"
          }
        }
      }
    }
  ],
  "$defs": {
    "BaseResponse": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Response type, \"sync\"."
        },
        "status-code": {
          "type": "integer",
          "description": "HTTP response status code."
        },
        "status": {
          "type": "string",
          "description": "The description of the HTTP status code.\n\nSee the [IANA list](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).\n"
        }
      }
    },
    "errorResult": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Error message."
        },
        "kind": {
          "type": "string",
          "description": "Type of error.",
          "enum": [
            "daemon-restart",
            "generic-file-error",
            "login-required",
            "no-default-services",
            "not-found",
            "permission-denied",
            "system-restart"
          ]
        },
        "value": {
          "type": "object",
          "description": "Additional error information, if any."
        }
      },
      "required": [
        "message"
      ]
    },
    "fileResult": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "error": {
          "$ref": "#/$defs/errorResult"
        }
      }
    }
  }
}