# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Organization Pipelines API
  version: 1.0.0
extends: openapi/edge-impulse-organizationpipelines-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: 8
- target: $.paths['/api/organizations/{organizationId}/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's pipelines
      effect: read
      questions:
      - What data pipelines does my Edge Impulse organization have set up?
      - Can I see only the pipelines tied to one particular project?
      instructions:
      - text: List all active pipelines in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show the pipelines in organization {organizationId} that belong to project {projectId}.
        slots:
          organizationId: path.organizationId
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organizational pipeline
      effect: write
      questions:
      - How do I set up a new pipeline of steps that runs on a schedule for my organization?
      - Can a new pipeline email specific people or call a webhook when it finishes?
      instructions:
      - text: Create a pipeline named {name} in organization {organizationId} with steps {steps}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
          steps: requestBody.steps
      - text: Set up a new pipeline {name} in organization {organizationId} that runs every {intervalStr}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
          intervalStr: requestBody.intervalStr
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/archived'].get
  update:
    x-apievangelist-phrasing:
      intent: List archived organizational pipelines
      effect: read
      questions:
      - Where can I find pipelines that were archived in my organization?
      - Which archived pipelines belonged to a specific project?
      instructions:
      - text: List the archived pipelines in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show archived pipelines in organization {organizationId} for project {projectId}.
        slots:
          organizationId: path.organizationId
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organizational pipeline
      effect: read
      questions:
      - What steps and schedule are configured on a specific pipeline?
      - Can I look up the details of a single pipeline by its ID?
      instructions:
      - text: Get pipeline {pipelineId} in organization {organizationId}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      - text: Show me the configuration of pipeline {pipelineId} from organization {organizationId}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/{pipelineId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing organizational pipeline
      effect: write
      questions:
      - How do I change the steps or schedule of a pipeline I already created?
      - Can I archive an existing pipeline by editing its settings?
      instructions:
      - text: Change the steps of existing pipeline {pipelineId} in organization {organizationId} to {steps}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
          steps: requestBody.steps
      - text: Rename pipeline {pipelineId} in organization {organizationId} to {name}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/{pipelineId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organizational pipeline
      effect: destructive
      questions:
      - How do I permanently remove a pipeline from my organization?
      - Can I delete a pipeline outright so it no longer appears even in the archive?
      instructions:
      - text: Delete pipeline {pipelineId} from organization {organizationId}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      - text: Remove pipeline {pipelineId} in organization {organizationId} for good.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/{pipelineId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an organizational pipeline now
      effect: write
      questions:
      - Can I trigger a pipeline immediately instead of waiting for its schedule?
      - Is it possible to rerun a pipeline while ignoring its last successful run?
      instructions:
      - text: Run pipeline {pipelineId} in organization {organizationId} now.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      - text: Start pipeline {pipelineId} in organization {organizationId} with ignore-last-successful-run set to {ignoreLastSuccessfulRun}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
          ignoreLastSuccessfulRun: query.ignoreLastSuccessfulRun
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/pipelines/{pipelineId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running pipeline
      effect: destructive
      questions:
      - How do I halt a pipeline that is currently running?
      - What happens to a pipeline run when I stop it partway through?
      instructions:
      - text: Stop the running pipeline {pipelineId} in organization {organizationId}.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      - text: Cancel the in-progress run of pipeline {pipelineId} for organization {organizationId} and mark it failed.
        slots:
          pipelineId: path.pipelineId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'