JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Pipelines REST Steps API

3 actions 3 updates phrasing extends openapi/jfrog-steps-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/steps/{stepId}'].get
$.paths['/v1/steps/{stepId}/logs'].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 Pipelines REST Steps API
  version: 1.0.0
extends: openapi/jfrog-steps-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/steps/{stepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline step's details
      effect: read
      questions:
      - How do I see the status of one pipeline step execution?
      - What details are recorded for a specific step run?
      instructions:
      - text: Show step {stepId}.
        slots:
          stepId: path.stepId
      - text: Get the execution details of step {stepId}.
        slots:
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/steps/{stepId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline step's console logs
      effect: read
      questions:
      - Where can I read the console output of a failed step?
      - Can I download the logs of a specific step?
      instructions:
      - text: Show console logs for step {stepId}.
        slots:
          stepId: path.stepId
      - text: Get the logs of step {stepId}.
        slots:
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'