JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST Builds API

5 actions 5 updates phrasing extends openapi/jfrog-builds-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['/api/build'].get
$.paths['/api/build/{buildName}'].get
$.paths['/api/build/{buildName}/{buildNumber}'].get
$.paths['/api/build/promote/{buildName}/{buildNumber}'].post

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 Artifactory REST Builds API
  version: 1.0.0
extends: openapi/jfrog-builds-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['/api/build'].get
  update:
    x-apievangelist-phrasing:
      intent: List all builds
      effect: read
      questions:
      - Which builds are stored in Artifactory?
      - Can I get a list of every build name?
      instructions:
      - text: List all builds.
      - text: Show every build stored in Artifactory.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/build/{buildName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of a build
      effect: read
      questions:
      - What runs exist for a particular build?
      - How do I see every build number for one build name?
      instructions:
      - text: List the runs of build {buildName}.
        slots:
          buildName: path.buildName
      - text: Show all build numbers for {buildName}.
        slots:
          buildName: path.buildName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/build/{buildName}/{buildNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get build info for a run
      effect: read
      questions:
      - How do I get the full build info for a specific build number?
      - Which modules and artifacts did a build run produce?
      instructions:
      - text: Show build info for {buildName} number {buildNumber}.
        slots:
          buildName: path.buildName
          buildNumber: path.buildNumber
      - text: Get the artifacts of build {buildName} run {buildNumber}.
        slots:
          buildName: path.buildName
          buildNumber: path.buildNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/build/promote/{buildName}/{buildNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a build to a target repository
      effect: write
      questions:
      - How do I promote a build's artifacts to a release repository?
      - Can I copy instead of move when promoting a build?
      - Can I include dependencies in a build promotion?
      instructions:
      - text: Promote build {buildName} {buildNumber} to {targetRepo}.
        slots:
          buildName: path.buildName
          buildNumber: path.buildNumber
          targetRepo: requestBody.targetRepo
      - text: Copy build {buildName} {buildNumber} to {targetRepo} with status {status}.
        slots:
          buildName: path.buildName
          buildNumber: path.buildNumber
          targetRepo: requestBody.targetRepo
          status: requestBody.status
      method: generated
      generated: '2026-10-01'