API Evangelist conversational phrasing for Harmony API Reference Projects API

# 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 Projects API
  version: 1.0.0
extends: openapi/jitterbit-projects-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: 10
- target: $.paths['/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Integration Studio project
      effect: read
      questions:
      - How do I retrieve the details of an Integration Studio project by its GUID?
      - What data comes back for a single project in a given environment?
      instructions:
      - text: Get project {projectGuid} in environment {environmentId} for org {organizationId}.
        slots:
          projectGuid: query.projectGuid
          environmentId: query.environmentId
          organizationId: header.organizationId
      - text: Show me the details of Integration Studio project {projectGuid}.
        slots:
          projectGuid: query.projectGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Deploy an Integration Studio project
      effect: write
      questions:
      - How do I deploy an Integration Studio project so its changes go live?
      - Can I push a project deployment without opening the Integration Studio UI?
      instructions:
      - text: Deploy project {projectGuid}.
        slots:
          projectGuid: requestBody.projectGuid
      - text: Redeploy Integration Studio project {projectGuid} with its latest changes.
        slots:
          projectGuid: requestBody.projectGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Integration Studio project
      effect: write
      questions:
      - Can I create a brand-new Integration Studio project through the Jitterbit API?
      - What organization details are needed to start a new integration project?
      instructions:
      - text: Create a new Integration Studio project in organization {organizationId}.
        slots:
          organizationId: header.organizationId
      - text: Start an empty integration project for my Harmony org {organizationId}.
        slots:
          organizationId: header.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Integration Studio project
      effect: destructive
      questions:
      - Can I permanently delete an Integration Studio project I no longer need?
      - What happens when I remove a project from its environment?
      instructions:
      - text: Delete the Integration Studio project I no longer use.
      - text: Remove that old integration project from its environment for good.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project-variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's variables
      effect: read
      questions:
      - Which project variables are defined on my Integration Studio project?
      - Can I read the current values of a project's variables in one environment?
      instructions:
      - text: List the project variables for project {projectGuid} in environment {environmentId}.
        slots:
          projectGuid: query.projectGuid
          environmentId: query.environmentId
      - text: Show me the variables configured on project {projectGuid}.
        slots:
          projectGuid: query.projectGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project-variables'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the value of a project variable
      effect: write
      questions:
      - Can I change a project variable's value or description through the API?
      - Is it possible to hide a project variable's value when I update it?
      instructions:
      - text: Set the value of my project variable to the new setting.
      - text: Update the project variable's description and mark its value as hidden.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project-import-export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a project to a JSON file
      effect: read
      questions:
      - How do I export an Integration Studio project as a JSON file?
      - Can I leave credentials or email notifications out of a project export?
      - Does an exported project include its operation schedules and variable defaults?
      instructions:
      - text: Export project {projectGuid} to a JSON file.
        slots:
          projectGuid: query.projectGuid
      - text: Export project {projectGuid} with credentials included set to {includeCredentials}.
        slots:
          projectGuid: query.projectGuid
          includeCredentials: query.includeCredentials
      - text: 'Download project {projectGuid} as JSON, include schedules: {includeSchedules}.'
        slots:
          projectGuid: query.projectGuid
          includeSchedules: query.includeSchedules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/project-import-export'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an exported project into an environment
      effect: write
      questions:
      - Can I import a previously exported project file into another environment?
      - What name will a project get when I load it from an export file?
      instructions:
      - text: Import the project file {document} into environment {targetEnvironmentId}.
        slots:
          document: requestBody.document
          targetEnvironmentId: requestBody.targetEnvironmentId
      - text: Load exported project {document} as {name} in environment {targetEnvironmentId}.
        slots:
          document: requestBody.document
          name: requestBody.name
          targetEnvironmentId: requestBody.targetEnvironmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/migration'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project that was already migrated
      effect: write
      questions:
      - How do I re-migrate a project that already exists in the target environment?
      - Can I replace an already migrated project copy with the latest source version?
      instructions:
      - text: Update the already migrated copy of my project in the target environment.
      - text: Replace the previously migrated project with the latest version from the source environment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/migration'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate a project to another environment
      effect: write
      questions:
      - Can I migrate an Integration Studio project from dev into a production environment for the first time?
      - What's needed to copy a project into an environment it has never been migrated to?
      instructions:
      - text: Migrate project {sourceProjectGuid} into environment {targetEnvironmentId}.
        slots:
          sourceProjectGuid: requestBody.sourceProjectGuid
          targetEnvironmentId: requestBody.targetEnvironmentId
      - text: Migrate project {sourceProjectGuid} to environment {targetEnvironmentId} tagged {projectHistoryTagName}.
        slots:
          sourceProjectGuid: requestBody.sourceProjectGuid
          targetEnvironmentId: requestBody.targetEnvironmentId
          projectHistoryTagName: requestBody.projectHistoryTagName
      method: generated
      generated: '2026-09-26'