Artifacts

Get artifact files

Changed on

Fetch the files of an artifact version (the live one unless version is given). Requires viewer access or higher. manifest=1 lists path, mime, size and sha256 without any content; paths reads only the files named. Before editing, read the files you change and pass version_no as base_version to POST /v1/artifacts/{id}/edits.

get/v1/artifacts/{id}/files

Request

  • Base URL
    https://shareout.site
  • URL
    https://shareout.site/v1/artifacts/{id}/files
  • Auth
    HTTP bearer

Query parameters

versionstring

Version number or ID. Defaults to the live (production) version.

manifest'1'

1: return [{path, mime, size, sha256}] only, from the database (no file content).

pathsstring

Comma-separated paths (or repeat the parameter) to read only those files. A path the version lacks is a 404 FILE_NOT_FOUND listing it under missing.

Response

Files for the version

artifact_idstring
version_idstring
version_nointeger
entrypointstring
live_versioninteger nullable

manifest=1 only: the version live in production.

newest_versioninteger nullable

manifest=1 only: the newest saved version — the base_version an edit needs. Ahead of live_version while a version waits on blocking tests.

unreadablestring[]

Files of the version whose stored bytes could not be read (absent when none).

Example response

{
  "files": [
    {
      "path": "img/logo@2x.png"
    }
  ]
}

Changes

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter manifest

    • info

      added the new optional query request parameter paths

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status