Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Time Tracking API

6 actions 6 updates phrasing extends openapi/atlassian-time-tracking-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 6

$.info
$.paths['/rest/api/3/configuration/timetracking'].get
$.paths['/rest/api/3/configuration/timetracking'].put
$.paths['/rest/api/3/configuration/timetracking/list'].get
$.paths['/rest/api/3/configuration/timetracking/options'].get
$.paths['/rest/api/3/configuration/timetracking/options'].put

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 Time Tracking API
  version: 1.0.0
extends: openapi/atlassian-time-tracking-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: 5
- target: $.paths['/rest/api/3/configuration/timetracking'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active time tracking provider
      effect: read
      questions:
      - Which time tracking provider is currently active on our site?
      - Is time tracking turned on at all?
      instructions:
      - text: Show the selected time tracking provider.
      - text: Tell me which time tracking provider is active right now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/configuration/timetracking'].put
  update:
    x-apievangelist-phrasing:
      intent: Switch the time tracking provider
      effect: write
      questions:
      - How do I switch time tracking to a Marketplace app?
      - Can I go back to the built-in time tracking provider?
      instructions:
      - text: Select the time tracking provider {key}.
        slots:
          key: requestBody.key
      - text: Switch time tracking to provider {key} named {name}.
        slots:
          key: requestBody.key
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/configuration/timetracking/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List the available time tracking providers
      effect: read
      questions:
      - What time tracking providers are installed and available to choose from?
      - Do we have any time tracking apps installed besides the built-in one?
      instructions:
      - text: List all available time tracking providers.
      - text: Show every time tracking option I could switch to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/configuration/timetracking/options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the time tracking settings
      effect: read
      questions:
      - How many hours make a working day in our time tracking settings?
      - What default time unit and display format does Jira use for logged time?
      instructions:
      - text: Show the time tracking settings.
      - text: Get the working hours, days and time format configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/configuration/timetracking/options'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the time tracking settings
      effect: write
      questions:
      - Can I change a working day to 7.5 hours for time tracking?
      - How do I set the default unit for logged work to hours?
      instructions:
      - text: Set time tracking to {workingHoursPerDay} hours per day, {workingDaysPerWeek} days per week, unit {defaultUnit}, format {timeFormat}.
        slots:
          workingHoursPerDay: requestBody.workingHoursPerDay
          workingDaysPerWeek: requestBody.workingDaysPerWeek
          defaultUnit: requestBody.defaultUnit
          timeFormat: requestBody.timeFormat
      - text: Change the default logged-time unit to {defaultUnit} with display format {timeFormat}.
        slots:
          defaultUnit: requestBody.defaultUnit
          timeFormat: requestBody.timeFormat
      method: generated
      generated: '2026-10-01'