Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content Watches API

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

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/wiki/rest/api/content/{id}/notification/child-created'].get
$.paths['/wiki/rest/api/content/{id}/notification/created'].get
$.paths['/wiki/rest/api/space/{spaceKey}/watch'].get
$.paths['/wiki/rest/api/user/watch/content/{contentId}'].get
$.paths['/wiki/rest/api/user/watch/content/{contentId}'].post
$.paths['/wiki/rest/api/user/watch/content/{contentId}'].delete
$.paths['/wiki/rest/api/user/watch/label/{labelName}'].get
$.paths['/wiki/rest/api/user/watch/label/{labelName}'].post
$.paths['/wiki/rest/api/user/watch/label/{labelName}'].delete
$.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].get
$.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].post
$.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].delete

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 Atlassian The Confluence Cloud REST Content Watches API
  version: 1.0.0
extends: openapi/atlassian-content-watches-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: 12
- target: $.paths['/wiki/rest/api/content/{id}/notification/child-created'].get
  update:
    x-apievangelist-phrasing:
      intent: List who watches a page
      effect: read
      questions:
      - Who is watching this Confluence page and will be notified when it changes?
      - How do I see the watchers on a specific page?
      instructions:
      - text: List the watchers of page {id}.
        slots:
          id: path.id
      - text: Show up to {limit} people watching page {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/notification/created'].get
  update:
    x-apievangelist-phrasing:
      intent: List space watches for a page's space
      effect: read
      questions:
      - Who watches the whole space that a given page lives in?
      - Can I find the space-level watchers starting from a piece of content?
      instructions:
      - text: List the space watchers for the space containing content {id}.
        slots:
          id: path.id
      - text: Show who watches the parent space of page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/watch'].get
  update:
    x-apievangelist-phrasing:
      intent: List watchers of a space by key
      effect: read
      questions:
      - Which users are watching a Confluence space?
      - How do I get the watcher list for a space key?
      instructions:
      - text: List watchers of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show the first {limit} watchers of space {spaceKey}.
        slots:
          limit: query.limit
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/content/{contentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a user watches a piece of content
      effect: read
      questions:
      - Am I watching this Confluence page?
      - Can I check whether a particular user is watching a piece of content?
      instructions:
      - text: Check if I'm watching content {contentId}.
        slots:
          contentId: path.contentId
      - text: Tell me whether user {accountId} watches content {contentId}.
        slots:
          accountId: query.accountId
          contentId: path.contentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/content/{contentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a watcher to a piece of content
      effect: write
      questions:
      - How do I start watching a Confluence page?
      - Can I make another user watch a page so they get notified?
      instructions:
      - text: Watch content {contentId} as me.
        slots:
          contentId: path.contentId
      - text: Add user {accountId} as a watcher of content {contentId}.
        slots:
          accountId: query.accountId
          contentId: path.contentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/content/{contentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a watcher from a piece of content
      effect: destructive
      questions:
      - How do I stop watching a Confluence page?
      - Can I unsubscribe another user from a page's notifications?
      instructions:
      - text: Stop watching content {contentId} with token header {X-Atlassian-Token}.
        slots:
          contentId: path.contentId
          X-Atlassian-Token: header.X-Atlassian-Token
      - text: Remove user {accountId} as a watcher of content {contentId}.
        slots:
          accountId: query.accountId
          contentId: path.contentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/label/{labelName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a user watches a label
      effect: read
      questions:
      - Am I following a particular Confluence label?
      - Can I see whether a user is watching a label?
      instructions:
      - text: Check if I watch label {labelName}.
        slots:
          labelName: path.labelName
      - text: Check whether user {accountId} watches label {labelName}.
        slots:
          accountId: query.accountId
          labelName: path.labelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/label/{labelName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Watch a label
      effect: write
      questions:
      - How do I get notified about content tagged with a certain label?
      - Can I subscribe another user to a label?
      instructions:
      - text: Watch label {labelName} for me with token {X-Atlassian-Token}.
        slots:
          labelName: path.labelName
          X-Atlassian-Token: header.X-Atlassian-Token
      - text: Add user {accountId} as a watcher of label {labelName}.
        slots:
          accountId: query.accountId
          labelName: path.labelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/label/{labelName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop watching a label
      effect: destructive
      questions:
      - How do I unfollow a label in Confluence?
      - Can I remove another user's watch on a label?
      instructions:
      - text: Stop watching label {labelName}.
        slots:
          labelName: path.labelName
      - text: Remove user {accountId} from the watchers of label {labelName}.
        slots:
          accountId: query.accountId
          labelName: path.labelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a user watches a space
      effect: read
      questions:
      - Am I watching this Confluence space?
      - Can I check if a specific user follows a space?
      instructions:
      - text: Check whether I'm watching space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Tell me if user {accountId} is watching space {spaceKey}.
        slots:
          accountId: query.accountId
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].post
  update:
    x-apievangelist-phrasing:
      intent: Watch a space
      effect: write
      questions:
      - How do I get notified about every change in a Confluence space?
      - Can I add a colleague as a watcher on a space?
      instructions:
      - text: Watch space {spaceKey} with token {X-Atlassian-Token}.
        slots:
          spaceKey: path.spaceKey
          X-Atlassian-Token: header.X-Atlassian-Token
      - text: Add user {accountId} as a watcher of space {spaceKey}.
        slots:
          accountId: query.accountId
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/watch/space/{spaceKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop watching a space
      effect: destructive
      questions:
      - How do I unwatch a Confluence space?
      - Can I stop another user's notifications for a space?
      instructions:
      - text: Stop watching space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Remove user {accountId} as a watcher of space {spaceKey}.
        slots:
          accountId: query.accountId
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'