request_export

{
  "name": "request_export",
  "resource": "application",
  "tier": "reversible",
  "summary": "Export one application's data from one environment: every table of its database written as one CSV file, all tables read under one repeatable-read transaction, and a manifest naming each file of the application's other storage areas with its version tag. The platform's deploy area is left out: its one pending zip per environment is no customer file, and it is deleted within a day. The files are written into the application's export area, `export-<application id>`, which the platform mints bound to the application. Answers 202 at once with the export id and the state `running`; `read_export` reads the progress and, once it ends, the manifest. A request while an export of the same application and environment runs answers that export. `mint_download_grant` answers the line that downloads a completed export's files, which count in the application's stored data until you delete them. `application` is required; `environment` is production where absent.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": false,
    "openWorldHint": false
  }
}

{
  "name": "request_export",
  "tier": "reversible",
  "scenario": "API-L0-18",
  "summary": "Export one application's data from one environment: every table of its database written as one CSV file, all tables read under one repeatable-read transaction. A manifest names each file of the application's other storage areas with its version tag. The platform's deploy area is left out: its one pending zip per environment is no customer file, and it is deleted within a day. The files are written into the application's export area, `export-<application id>`, which the platform mints bound to the application. Answers 202 at once with the export id and the state `running`; `read_export` reads the progress and, once it ends, the manifest. A request while an export of the same application and environment runs answers that export. `mint_download_grant` answers the line that downloads a completed export's files, which count in the application's stored data until you delete them. `application` is required; `environment` is production where absent.",
  "owners": [
    "API-L0-18",
    "API-L0-23",
    "MAPI-21",
    "OST-L0-01"
  ]
}

{
  "request": {
    "type": "object",
    "required": [
      "application"
    ],
    "properties": {
      "application": {
        "type": "string",
        "description": "The id of the application whose database and files the export reads, one of the acting account's; `list_applications` answers it."
      },
      "environment": {
        "type": "string",
        "enum": [
          "development",
          "production"
        ],
        "description": "The environment whose database and area partitions the export reads; production where absent."
      }
    }
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "export",
      "application",
      "environment",
      "state",
      "area",
      "folder",
      "requested_at",
      "repeated"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "reference": {
        "type": "string",
        "pattern": "^[0-9a-f]{10}$",
        "description": "The short reference the platform recorded this call under, ten lowercase hexadecimal characters, the value the call’s record row carries; quote it when reporting the call."
      },
      "export": {
        "type": "string",
        "description": "The export's id, the one `read_export` takes."
      },
      "application": {
        "type": "string"
      },
      "environment": {
        "type": "string",
        "enum": [
          "development",
          "production"
        ]
      },
      "state": {
        "type": "string",
        "enum": [
          "running"
        ],
        "description": "`running` at the answer, which precedes the work; a repeated answer names the export already running."
      },
      "area": {
        "type": "string",
        "description": "The export area the files are written into, `export-<application id>`."
      },
      "folder": {
        "type": "string",
        "description": "The folder under the area that holds this export's files, `<export id>/`."
      },
      "requested_at": {
        "type": "string"
      },
      "repeated": {
        "type": "boolean",
        "description": "true where an export of the same application and environment was already running and this answer names it; no second export started."
      },
      "detail": {
        "type": "string"
      },
      "page": {
        "$ref": "#/shapes/page"
      }
    },
    "description": "Answered 202 at once, before the pass starts writing, on `deploy`'s shape: the export's row was written `running` and the pass continues after the answer; `read_export` reads its end."
  }
}