Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Comments API

3 actions 3 updates phrasing extends openapi/canva-comments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Canva's API. It is a proposal applied on top of the contract, not a document Canva publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/comments'].post
$.paths['/comments/{commentId}/replies'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canva Connect Comments API
  version: 1.0.0
extends: openapi/canva-comments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a top-level comment to a design
      effect: write
      questions:
      - How do I leave a new comment on a Canva design?
      - Can I mention a teammate inside a comment?
      - Is it possible to assign a comment to someone?
      instructions:
      - text: Comment {message} on {attached_to}.
        slots:
          message: requestBody.message
          attached_to: requestBody.attached_to
      - text: Add comment {message} to {attached_to} and assign it to {assignee_id}.
        slots:
          message: requestBody.message
          attached_to: requestBody.attached_to
          assignee_id: requestBody.assignee_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/comments/{commentId}/replies'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to an existing comment
      effect: write
      questions:
      - How do I reply to an existing comment on a design?
      - What do I need to answer a comment someone already left?
      instructions:
      - text: Reply {message} to comment {commentId} on {attached_to}.
        slots:
          message: requestBody.message
          commentId: path.commentId
          attached_to: requestBody.attached_to
      - text: Answer comment {commentId} on {attached_to} with {message}.
        slots:
          commentId: path.commentId
          attached_to: requestBody.attached_to
          message: requestBody.message
      method: generated
      generated: '2026-09-26'