Jitterbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harmony API Reference Schedules API

6 actions 6 updates phrasing extends openapi/jitterbit-schedules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Jitterbit's API. It is a proposal applied on top of the contract, not a document Jitterbit publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/schedules'].get
$.paths['/schedules'].put
$.paths['/schedules'].post
$.paths['/schedules'].delete
$.paths['/schedules-toggle'].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 Harmony API Reference Schedules API
  version: 1.0.0
extends: openapi/jitterbit-schedules-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: 5
- target: $.paths['/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's operation schedules
      effect: read
      questions:
      - How do I see all the operation schedules set up for an Integration Studio project?
      - Which schedules are attached to my project in a given environment?
      instructions:
      - text: List the operation schedules for project {projectGuid} in environment {environmentId}.
        slots:
          projectGuid: query.projectGuid
          environmentId: query.environmentId
      - text: Show me every schedule defined on project {projectGuid}.
        slots:
          projectGuid: query.projectGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing operation schedule
      effect: write
      questions:
      - Can I change the timing of an operation schedule that already exists?
      - What do I call to edit a schedule rather than create a new one?
      instructions:
      - text: Update my existing operation schedule with the new timing settings.
      - text: Edit the schedule that is already set up and save the changes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an operation schedule for a project
      effect: write
      questions:
      - Can I create a new schedule so my Jitterbit operations run automatically?
      - What frequency, occurrence and duration settings go into a new operation schedule?
      instructions:
      - text: Create a schedule named {scheduleName} for project {projectGuid} in environment {environmentId}.
        slots:
          scheduleName: requestBody.scheduleName
          projectGuid: requestBody.projectGuid
          environmentId: requestBody.environmentId
      - text: Add a new operation schedule {scheduleName} that runs with frequency {frequency}.
        slots:
          scheduleName: requestBody.scheduleName
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an operation schedule
      effect: destructive
      questions:
      - How do I permanently remove an operation schedule from an environment?
      - Can I delete a schedule by its ID?
      instructions:
      - text: Delete schedule {scheduleId} from environment {environmentId}.
        slots:
          scheduleId: query.scheduleId
          environmentId: query.environmentId
      - text: Remove operation schedule {scheduleId} entirely.
        slots:
          scheduleId: query.scheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules-toggle'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn an operation schedule on or off
      effect: write
      questions:
      - Can I pause a schedule without deleting it?
      - Is there a way to switch an operation schedule back on after disabling it?
      instructions:
      - text: Disable schedule {scheduleGuid} in environment {environmentId}.
        slots:
          scheduleGuid: query.scheduleGuid
          environmentId: query.environmentId
      - text: Set enabled to {enable} for schedule {scheduleGuid} in environment {environmentId}.
        slots:
          enable: query.enable
          scheduleGuid: query.scheduleGuid
          environmentId: query.environmentId
      method: generated
      generated: '2026-09-26'