POpolytomic
Harbors

Update Harbor Context

Changed on

Replaces one Harbor context document.

Each successful request publishes the next immutable version. You can omit change_note.

A direct publication leaves an existing draft unchanged.

put/api/harbors/{harbor_id}/contexts/{context_id}

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor

Example:248df4b7-aa70-47b8-a036-33ac447e668d
context_idstring uuid required

Unique identifier of the context document

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring
X-Polytomic-Harbor-Sessionstring

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstring

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

Request body

change_notestring nullable

Optional note describing this published change

contentstring required

Plain-text context content. Maximum 20,000 characters.

descriptionstring

Short summary of the context document. Maximum 1,000 characters.

titlestring required

Human-readable context title. Maximum 200 characters.

Example request

{
  "change_note": "Clarify fiscal-year terminology",
  "content": "Bookings use the contract signed date...",
  "description": "Definitions used in revenue reporting",
  "title": "Revenue definitions"
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "revision_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for 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

    • 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

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 30ade6c6d535Revision changes
    • info

      added the new optional header request parameter X-Polytomic-Activity-Request-ID

    • info

      added the new optional header request parameter X-Polytomic-Harbor-Session

    • info

      added the optional property / to the response with the status