v1
Deliverable Files
Deliverable Files

Update Deliverable File Description

Set the canonical uploader note on files.description (feat/NoteonFileUpload).

The note is a property of the file, so it lives on the files row and is read everywhere the file appears. Scoped to the deliverable's owner both by shop-access assertion and by the owner-filtered update in the service.

Body: {"description": str} (empty/whitespace clears the note). Returns 200 {data: files_row} or 404 when the file isn't in this deliverable.

patch/api/v1/deliverables/{deliverable_id}/files/{files_id}/description

Request

  • Base URL: https://api.jeevyfabrication.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.jeevyfabrication.com/api/v1/deliverables/{deliverable_id}/files/{files_id}/description
  • Auth: none declared

Path parameters

deliverable_idstring required

Deliverable UUID

files_idinteger required

files.id of the file to annotate

Request body

object required

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.