# 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 Worklogs API
  version: 1.0.0
extends: openapi/atlassian-issue-worklogs-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['/rest/api/3/issue/{issueIdOrKey}/worklog'].get
  update:
    x-apievangelist-phrasing:
      intent: List worklogs on an issue
      effect: read
      questions:
      - How do I see all the time logged against a Jira issue?
      - Can I get only worklogs started within a date range?
      instructions:
      - text: List worklogs on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show worklogs on {issueIdOrKey} started after {startedAfter} and before {startedBefore}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          startedAfter: query.startedAfter
          startedBefore: query.startedBefore
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog'].post
  update:
    x-apievangelist-phrasing:
      intent: Log time on an issue
      effect: write
      questions:
      - How do I log hours worked on a Jira issue?
      - Can logging time also reduce the remaining estimate automatically?
      instructions:
      - text: Log {timeSpent} on issue {issueIdOrKey}.
        slots:
          timeSpent: requestBody.timeSpent
          issueIdOrKey: path.issueIdOrKey
      - text: Add a worklog of {timeSpent} to {issueIdOrKey} starting {started} with comment {comment}.
        slots:
          timeSpent: requestBody.timeSpent
          issueIdOrKey: path.issueIdOrKey
          started: requestBody.started
          comment: requestBody.comment
      - text: Log {timeSpent} on {issueIdOrKey} and set the remaining estimate to {newEstimate}.
        slots:
          timeSpent: requestBody.timeSpent
          issueIdOrKey: path.issueIdOrKey
          newEstimate: query.newEstimate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one worklog on an issue
      effect: read
      questions:
      - How do I look up a single worklog entry on an issue?
      - Can I see who logged a particular time entry and when?
      instructions:
      - text: Get worklog {id} on issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Show the details of time entry {id} on {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a worklog
      effect: write
      questions:
      - How do I correct the time on a worklog I already logged?
      - Can I change a worklog without notifying watchers?
      instructions:
      - text: Change worklog {id} on {issueIdOrKey} to {timeSpent}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          timeSpent: requestBody.timeSpent
      - text: Update the comment on worklog {id} of {issueIdOrKey} to {comment} without notifying users ({notifyUsers}).
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          comment: requestBody.comment
          notifyUsers: query.notifyUsers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a worklog
      effect: destructive
      questions:
      - How do I remove a time entry from a Jira issue?
      - Can deleting a worklog add the time back to the remaining estimate?
      instructions:
      - text: Delete worklog {id} from issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Delete worklog {id} on {issueIdOrKey} and increase the estimate by {increaseBy}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          increaseBy: query.increaseBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/worklog/deleted'].get
  update:
    x-apievangelist-phrasing:
      intent: List worklogs deleted since a time
      effect: read
      questions:
      - Which worklogs were deleted after a certain date?
      - How do I sync deletions of time entries since my last run?
      instructions:
      - text: List ids of worklogs deleted since {since}.
        slots:
          since: query.since
      - text: Show recently deleted worklog ids.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/worklog/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Get worklog details for a list of ids
      effect: read
      questions:
      - How do I fetch full worklog details for a batch of worklog ids?
      - What's the maximum number of worklogs I can fetch by id at once?
      instructions:
      - text: Get worklog details for ids {ids}.
        slots:
          ids: requestBody.ids
      - text: Fetch the full records for worklogs {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/worklog/updated'].get
  update:
    x-apievangelist-phrasing:
      intent: List worklogs updated since a time
      effect: read
      questions:
      - Which worklogs were created or changed after a given date?
      - How do I pull incremental updates to time tracking since a timestamp?
      instructions:
      - text: List ids of worklogs updated since {since}.
        slots:
          since: query.since
      - text: Show worklogs modified recently.
      method: generated
      generated: '2026-10-01'