Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Watchers API

5 actions 5 updates phrasing extends openapi/atlassian-issue-watchers-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 5

$.info

$.paths['/rest/api/3/issue/watching'].post

$.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].get

$.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].post

$.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].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 Atlassian The Jira Cloud platform REST Issue Watchers API
  version: 1.0.0
extends: openapi/atlassian-issue-watchers-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: 4
- target: $.paths['/rest/api/3/issue/watching'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which issues I'm watching
      effect: read
      questions:
      - Am I watching any of these Jira issues?
      - Can I check my watch status for a whole list of issues in one call?
      instructions:
      - text: Check whether I'm watching issues {issueIds}.
        slots:
          issueIds: requestBody.issueIds
      - text: Tell me my watched status for issue IDs {issueIds}.
        slots:
          issueIds: requestBody.issueIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].get
  update:
    x-apievangelist-phrasing:
      intent: List who is watching an issue
      effect: read
      questions:
      - Who is watching a particular Jira issue?
      - How many people are following this issue for updates?
      instructions:
      - text: List the watchers of issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show who follows Jira issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].post
  update:
    x-apievangelist-phrasing:
      intent: Start watching an issue
      effect: write
      questions:
      - How do I add myself or a teammate as a watcher on a Jira issue?
      - Does adding a watcher without specifying a user add me?
      instructions:
      - text: Add me as a watcher on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Make a teammate watch Jira issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/watchers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop a user watching an issue
      effect: destructive
      questions:
      - Can I remove someone from an issue's watcher list?
      - What do I need to stop a user getting notifications for an issue?
      instructions:
      - text: Remove user {accountId} as a watcher of issue {issueIdOrKey}.
        slots:
          accountId: query.accountId
          issueIdOrKey: path.issueIdOrKey
      - text: Stop account {accountId} watching Jira issue {issueIdOrKey}.
        slots:
          accountId: query.accountId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'