Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Smart Link API

4 actions 4 updates phrasing extends openapi/confluence-smart-link-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/embeds'].post

$.paths['/embeds/{id}'].get

$.paths['/embeds/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 Smart Link API
  version: 1.0.0
extends: openapi/confluence-smart-link-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/embeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Smart Link to a space's content tree
      effect: write
      questions:
      - How do I add an external URL as a Smart Link in a space's page tree?
      - Can I place a Smart Link under a specific parent page?
      instructions:
      - text: Create a Smart Link to {embedUrl} in space {spaceId}.
        slots:
          embedUrl: requestBody.embedUrl
          spaceId: requestBody.spaceId
      - text: Add Smart Link {title} pointing at {embedUrl} under parent {parentId} in space {spaceId}.
        slots:
          title: requestBody.title
          embedUrl: requestBody.embedUrl
          parentId: requestBody.parentId
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Smart Link by id
      effect: read
      questions:
      - How do I look up a Smart Link in the content tree?
      - Can I include a Smart Link's properties and permitted operations when fetching it?
      instructions:
      - text: Get Smart Link {id}.
        slots:
          id: path.id
      - text: Show Smart Link {id} along with its collaborators.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Move a Smart Link to the trash
      effect: destructive
      questions:
      - How do I remove a Smart Link from the content tree?
      - Is a deleted Smart Link recoverable from the trash?
      instructions:
      - text: Delete Smart Link {id}.
        slots:
          id: path.id
      - text: Move Smart Link {id} to the trash.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'