JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Pipelines REST Runs API

5 actions 5 updates phrasing extends openapi/jfrog-runs-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for JFrog's API. It is a proposal applied on top of the contract, not a document JFrog publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/runs'].get

$.paths['/v1/runs/{runId}'].get

$.paths['/v1/runs/{runId}/cancel'].post

$.paths['/v1/pipelines/{pipelineId}/trigger'].post

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 JFrog Pipelines REST Runs API
  version: 1.0.0
extends: openapi/jfrog-runs-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: 4
- target: $.paths['/v1/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipeline runs
      effect: read
      questions:
      - Which pipeline runs have failed recently?
      - Can I list runs for specific pipelines only?
      instructions:
      - text: List recent pipeline runs.
      - text: List runs for pipelines {pipelineIds} with status codes {statusCodes}.
        slots:
          pipelineIds: query.pipelineIds
          statusCodes: query.statusCodes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline run
      effect: read
      questions:
      - What is the status of a particular pipeline run?
      - Can I see the details of one run by its ID?
      instructions:
      - text: Get pipeline run {runId}.
        slots:
          runId: path.runId
      - text: Show me how run {runId} is going.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/runs/{runId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pipeline run
      effect: destructive
      questions:
      - How do I stop a pipeline run that is in progress?
      - Can I cancel a run that was started by mistake?
      instructions:
      - text: Cancel pipeline run {runId}.
        slots:
          runId: path.runId
      - text: Stop the running execution {runId}.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pipelines/{pipelineId}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a pipeline run
      effect: write
      questions:
      - How do I start a new run of a pipeline on demand?
      - Can I pass environment variables when triggering a pipeline?
      instructions:
      - text: Trigger pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Start pipeline {pipelineId} on branch {branchName} with env vars {environmentVariables}.
        slots:
          pipelineId: path.pipelineId
          branchName: requestBody.branchName
          environmentVariables: requestBody.environmentVariables
      method: generated
      generated: '2026-10-01'