Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Like API

9 actions 9 updates phrasing extends openapi/confluence-like-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 9

$.info
$.paths['/blogposts/{id}/likes/count'].get
$.paths['/blogposts/{id}/likes/users'].get
$.paths['/pages/{id}/likes/count'].get
$.paths['/pages/{id}/likes/users'].get
$.paths['/footer-comments/{id}/likes/count'].get
$.paths['/footer-comments/{id}/likes/users'].get
$.paths['/inline-comments/{id}/likes/count'].get
$.paths['/inline-comments/{id}/likes/users'].get

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 Confluence Cloud REST API v2 Like API
  version: 1.0.0
extends: openapi/confluence-like-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: 8
- target: $.paths['/blogposts/{id}/likes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count likes on a blog post
      effect: read
      questions:
      - How many likes has a blog post received?
      - Can I get just the like total for a blog post?
      instructions:
      - text: Count the likes on blog post {id}.
        slots:
          id: path.id
      - text: Tell me how many people liked blog post {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/likes/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List who liked a blog post
      effect: read
      questions:
      - Who liked a particular blog post?
      - Can I get the account IDs of everyone who liked a blog post?
      instructions:
      - text: List the accounts that liked blog post {id}.
        slots:
          id: path.id
      - text: Show the first {limit} people who liked blog post {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/likes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count likes on a page
      effect: read
      questions:
      - How many likes does a Confluence page have?
      - Can I check the like total on a page?
      instructions:
      - text: Count the likes on page {id}.
        slots:
          id: path.id
      - text: Tell me how many people liked page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/likes/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List who liked a page
      effect: read
      questions:
      - Who has liked a specific page?
      - Can I page through the account IDs of a page's likers?
      instructions:
      - text: List the accounts that liked page {id}.
        slots:
          id: path.id
      - text: Show the first {limit} people who liked page {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/footer-comments/{id}/likes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count likes on a footer comment
      effect: read
      questions:
      - How many likes did a footer comment at the bottom of a page get?
      - What's the like total on a page-level comment?
      instructions:
      - text: Count the likes on footer comment {id}.
        slots:
          id: path.id
      - text: Tell me how many people liked footer comment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/footer-comments/{id}/likes/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List who liked a footer comment
      effect: read
      questions:
      - Who liked a footer comment on a page?
      - Can I get the account IDs behind a footer comment's likes?
      instructions:
      - text: List the accounts that liked footer comment {id}.
        slots:
          id: path.id
      - text: Show the first {limit} people who liked footer comment {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inline-comments/{id}/likes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count likes on an inline comment
      effect: read
      questions:
      - How many likes does an inline comment on highlighted text have?
      - What's the like total for an inline comment?
      instructions:
      - text: Count the likes on inline comment {id}.
        slots:
          id: path.id
      - text: Tell me how many people liked inline comment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inline-comments/{id}/likes/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List who liked an inline comment
      effect: read
      questions:
      - Who liked an inline comment?
      - Can I get the account IDs of people who liked an inline comment?
      instructions:
      - text: List the accounts that liked inline comment {id}.
        slots:
          id: path.id
      - text: Show the first {limit} people who liked inline comment {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'