JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog REST Pipelines API

3 actions 3 updates phrasing extends openapi/jfrog-pipelines-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 3

$.info
$.paths['/v1/pipelines'].get
$.paths['/v1/pipelines/{pipelineId}'].get

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 JFrog REST Pipelines API
  version: 1.0.0
extends: openapi/jfrog-pipelines-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: 2
- target: $.paths['/v1/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipelines
      effect: read
      questions:
      - Which pipelines are defined in my Pipelines setup?
      - Can I filter pipelines by name or pipeline source?
      instructions:
      - text: List all pipelines.
      - text: List pipelines named {names} from sources {pipelineSourceIds}.
        slots:
          names: query.names
          pipelineSourceIds: query.pipelineSourceIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline
      effect: read
      questions:
      - What are the details of a particular pipeline definition?
      - Can I look up one pipeline by its ID?
      instructions:
      - text: Get pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Show me the definition of pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'