Atlassian · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/rest/api/3/issue/{issueIdOrKey}/votes'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/votes'].post
$.paths['/rest/api/3/issue/{issueIdOrKey}/votes'].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 Jira Cloud platform REST Issue Votes API
  version: 1.0.0
extends: openapi/atlassian-issue-votes-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['/rest/api/3/issue/{issueIdOrKey}/votes'].get
  update:
    x-apievangelist-phrasing:
      intent: See votes on an issue
      effect: read
      questions:
      - How many votes does a Jira issue have and who voted?
      - Have I already voted on this issue?
      instructions:
      - text: Show the votes on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Get the vote count and voters for {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/votes'].post
  update:
    x-apievangelist-phrasing:
      intent: Vote for an issue
      effect: write
      questions:
      - How do I vote for a Jira issue I care about?
      - What setting must be on before I can vote on issues?
      instructions:
      - text: Vote for issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Add my vote to {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/votes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my vote from an issue
      effect: destructive
      questions:
      - How do I take back my vote on a Jira issue?
      - Can I unvote an issue I voted for earlier?
      instructions:
      - text: Remove my vote from issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Unvote {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'