Jitterbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harmony API Reference Operations API

3 actions 3 updates phrasing extends openapi/jitterbit-operations-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 3

$.info

$.paths['/operation-logs'].get

$.paths['/operation-logs'].put

OpenAPI Overlay

# 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 Operations API
  version: 1.0.0
extends: openapi/jitterbit-operations-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: 2
- target: $.paths['/operation-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get log details for one operation run
      effect: read
      questions:
      - How do I see the log details for a single execution of an Integration Studio operation?
      - Can I look up what happened in one specific operation instance by its GUID?
      instructions:
      - text: Show the log details for operation instance {operationInstanceGuid}.
        slots:
          operationInstanceGuid: query.operationInstanceGuid
      - text: Pull the detailed log of operation run {operationInstanceGuid} so I can see why it failed.
        slots:
          operationInstanceGuid: query.operationInstanceGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation-logs'].put
  update:
    x-apievangelist-phrasing:
      intent: List operation logs for an organization
      effect: read
      questions:
      - Where can I retrieve the operation logs across my Harmony organization?
      - What operation runs have been logged for my Integration Studio operations?
      instructions:
      - text: List the operation logs for Harmony organization {organizationId}.
        slots:
          organizationId: header.organizationId
      - text: Fetch the recent Integration Studio operation logs in org {organizationId}.
        slots:
          organizationId: header.organizationId
      method: generated
      generated: '2026-09-26'