Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-issue-worklog-properties-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/{issueIdOrKey}/worklog/{worklogId}/properties'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].put
$.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].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 Worklog…
  version: 1.0.0
extends: openapi/atlassian-issue-worklog-properties-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/{issueIdOrKey}/worklog/{worklogId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List property keys on a worklog
      effect: read
      questions:
      - What custom properties are stored on a worklog?
      - Can I see the property keys of a time entry on an issue?
      instructions:
      - text: List property keys for worklog {worklogId} on issue {issueIdOrKey}.
        slots:
          worklogId: path.worklogId
          issueIdOrKey: path.issueIdOrKey
      - text: Show which properties exist on issue {issueIdOrKey}'s worklog {worklogId}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a worklog property's value
      effect: read
      questions:
      - How do I read custom data I stored on a worklog?
      - Can I fetch one worklog property by its key?
      instructions:
      - text: Get property {propertyKey} of worklog {worklogId} on issue {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          worklogId: path.worklogId
          issueIdOrKey: path.issueIdOrKey
      - text: Read the {propertyKey} value stored on issue {issueIdOrKey} worklog {worklogId}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store custom data on a worklog
      effect: write
      questions:
      - Can I attach custom JSON data to 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:
          propertyKey: path.propertyKey
          worklogId: path.worklogId
          issueIdOrKey: path.issueIdOrKey
      - text: Save custom data under {propertyKey} for issue {issueIdOrKey} worklog {worklogId}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a worklog property
      effect: destructive
      questions:
      - How do I remove custom data from a worklog?
      - Which permissions are needed to delete a worklog property?
      instructions:
      - text: Delete property {propertyKey} from worklog {worklogId} on issue {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          worklogId: path.worklogId
          issueIdOrKey: path.issueIdOrKey
      - text: Clear the {propertyKey} property on issue {issueIdOrKey} worklog {worklogId}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
          worklogId: path.worklogId
      method: generated
      generated: '2026-10-01'