JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Pipelines REST Pipeline Sources API

5 actions 5 updates phrasing extends openapi/jfrog-pipeline-sources-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/pipelineSources'].get
$.paths['/v1/pipelineSources'].post
$.paths['/v1/pipelineSources/{pipelineSourceId}'].get
$.paths['/v1/pipelineSources/{pipelineSourceId}'].delete

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 Pipelines REST Pipeline Sources API
  version: 1.0.0
extends: openapi/jfrog-pipeline-sources-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/pipelineSources'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipeline sources
      effect: read
      questions:
      - Which repositories are registered as pipeline sources?
      - Can I see all pipeline source configurations?
      instructions:
      - text: List all pipeline sources.
      - text: Show every pipeline source configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pipelineSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a pipeline source repository
      effect: write
      questions:
      - How do I point Pipelines at a Git repository with my pipeline definitions?
      - Can I limit a pipeline source to files matching a filter?
      instructions:
      - text: Add pipeline source {repositoryFullName} on branch {branch} using integration {integrationId}.
        slots:
          repositoryFullName: requestBody.repositoryFullName
          branch: requestBody.branch
          integrationId: requestBody.integrationId
      - text: Register {repositoryFullName} branch {branch} via integration {integrationId} with file filter {fileFilter}.
        slots:
          repositoryFullName: requestBody.repositoryFullName
          branch: requestBody.branch
          integrationId: requestBody.integrationId
          fileFilter: requestBody.fileFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pipelineSources/{pipelineSourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline source
      effect: read
      questions:
      - Which branch is a specific pipeline source tracking?
      - How do I see one pipeline source's settings?
      instructions:
      - text: Show pipeline source {pipelineSourceId}.
        slots:
          pipelineSourceId: path.pipelineSourceId
      - text: Get details of pipeline source {pipelineSourceId}.
        slots:
          pipelineSourceId: path.pipelineSourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/pipelineSources/{pipelineSourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline source
      effect: destructive
      questions:
      - How do I remove a pipeline source?
      - Can I delete a pipeline source by ID?
      instructions:
      - text: Delete pipeline source {pipelineSourceId}.
        slots:
          pipelineSourceId: path.pipelineSourceId
      - text: Remove pipeline source {pipelineSourceId}.
        slots:
          pipelineSourceId: path.pipelineSourceId
      method: generated
      generated: '2026-10-01'