# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue worklogs API
  version: 1.0.0
extends: openapi/jira-issue-worklogs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog'].get
  update:
    x-apievangelist-phrasing:
      intent: List worklogs on an issue
      effect: read
      questions:
      - How much time has been logged on an issue and by whom?
      - Can I list only worklogs started within a date range on one issue?
      instructions:
      - text: List the 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-09-26'
- 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 against an 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
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete worklogs from an issue
      effect: destructive
      questions:
      - Can I delete many worklogs from one issue at once?
      - Are notifications sent when worklogs are removed in bulk?
      instructions:
      - text: Delete worklogs {ids} from issue {issueIdOrKey}.
        slots:
          ids: requestBody.ids
          issueIdOrKey: path.issueIdOrKey
      - text: Bulk remove worklogs {ids} on {issueIdOrKey} and adjust the estimate with {adjustEstimate}.
        slots:
          ids: requestBody.ids
          issueIdOrKey: path.issueIdOrKey
          adjustEstimate: query.adjustEstimate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move worklogs from one issue to another
      effect: write
      questions:
      - Time got logged on the wrong issue; can I move those worklogs elsewhere?
      - What limits apply when moving up to 5000 worklogs between issues?
      instructions:
      - text: Move worklogs {ids} from issue {issueIdOrKey} to {destination}.
        slots:
          ids: requestBody.ids
          issueIdOrKey: path.issueIdOrKey
          destination: requestBody.issueIdOrKey
      - text: Transfer the logged time in worklogs {ids} off {issueIdOrKey} onto issue {destination}.
        slots:
          ids: requestBody.ids
          issueIdOrKey: path.issueIdOrKey
          destination: requestBody.issueIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single worklog
      effect: read
      questions:
      - Can I look up one specific worklog entry on an issue?
      - What details does a single worklog record hold?
      instructions:
      - text: Get worklog {id} on issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Show the time spent and author of worklog {id} for {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a worklog
      effect: write
      questions:
      - How do I correct the time spent on a worklog I already logged?
      - Can I change a worklog's comment 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 issue {issueIdOrKey} to {comment}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- 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 single time entry from an issue?
      - When I delete a worklog, can the remaining estimate be increased back?
      instructions:
      - text: Delete worklog {id} from issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Remove worklog {id} on {issueIdOrKey} and increase the estimate by {increaseBy}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          increaseBy: query.increaseBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/worklog/deleted'].get
  update:
    x-apievangelist-phrasing:
      intent: List worklogs deleted since a time
      effect: read
      questions:
      - Which worklogs have been deleted since my last sync?
      - Can I get IDs of removed time entries after a given timestamp?
      instructions:
      - text: List IDs of worklogs deleted since {since}.
        slots:
          since: query.since
      - text: Get worklog deletions after timestamp {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/worklog/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Get worklogs by a list of IDs
      effect: read
      questions:
      - Can I fetch full details for a batch of worklog IDs?
      - What is the cap on worklogs returned by ID in one request?
      instructions:
      - text: Get the worklogs with IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Fetch full worklog details for the ID list {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- 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 since a certain time?
      - Is there a way to sync only the worklogs that were updated recently?
      instructions:
      - text: List IDs of worklogs updated since {since}.
        slots:
          since: query.since
      - text: Get worklogs modified after {since} with {expand} expanded.
        slots:
          since: query.since
          expand: query.expand
      method: generated
      generated: '2026-09-26'