enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.textStyleLibrary.publish

Enhance documentation

canvas.textStyleLibrary.publish

Publish selected text style changes without exposing unfinished edits or updating consumer files.

↓ Markdown

canvas.textStyleLibrary.publish

mutation write

Use when the requested change exactly matches canvas.textStyleLibrary.publish; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mutationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"documentVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"publish":{"type":"array","items":{"type":"string","minLength":1}},"remove":{"type":"array","items":{"type":"string","minLength":1}},"description":{"type":"string","maxLength":2000}},"required":["canvasId","mutationId","expectedRevision","documentVersion","publish","remove","description"],"additionalProperties":false}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "mutationId": "00000000-0000-4000-8000-000000000010",
 "expectedRevision": 0,
 "documentVersion": 1,
 "publish": [
  "body"
 ],
 "remove": [],
 "description": "Publish the Body text style."
}

Result

Returns a typed canvas.textStyleLibrary.publish result from the Enhance API without transport-specific prose.

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Read the affected canvas resource to confirm the result.

Compatibility: f1476045cfb9cc231ab5718503d440cd50be0a4892a8e93121c3ec39269e4780.