# 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 worklog properties API
  version: 1.0.0
extends: openapi/jira-issue-worklog-properties-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: 4
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a worklog's property keys
      effect: read
      questions:
      - What custom property keys are stored on a worklog?
      - Can I see which data keys an app has saved against a time log entry?
      instructions:
      - text: List the property keys on worklog {worklogId} of issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      - text: Show custom data keys for worklog {worklogId} on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a worklog property
      effect: read
      questions:
      - What value is stored under a property key on a worklog?
      - Can I read custom data attached to a time log entry?
      instructions:
      - text: Get property {propertyKey} from worklog {worklogId} on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      - text: Read worklog {worklogId}'s {propertyKey} value on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a property on a worklog
      effect: write
      questions:
      - Can I store my own JSON data on a worklog entry?
      - What's the size limit for a worklog property value?
      instructions:
      - text: Set property {propertyKey} on worklog {worklogId} of issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      - text: Save custom data under {propertyKey} for worklog {worklogId} on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a worklog property
      effect: destructive
      questions:
      - Can I remove custom data I stored on a worklog?
      - Who can delete a property from a time log entry?
      instructions:
      - text: Delete property {propertyKey} from worklog {worklogId} on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      - text: Remove the {propertyKey} data from worklog {worklogId} on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'