JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Release Lifecycle Management REST Promotion API

3 actions 3 updates phrasing extends openapi/jfrog-promotion-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['/v2/promotion/records/{name}/{version}'].get
$.paths['/v2/promotion'].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 Release Lifecycle Management REST Promotion API
  version: 1.0.0
extends: openapi/jfrog-promotion-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['/v2/promotion/records/{name}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release bundle's promotion history
      effect: read
      questions:
      - Which environments has a release bundle version been promoted to?
      - How do I check the promotion status of a bundle version?
      instructions:
      - text: Show promotion history for release bundle {name} {version}.
        slots:
          name: path.name
          version: path.version
      - text: Check promotion status of {name} version {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/promotion'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a release bundle to an environment
      effect: write
      questions:
      - How do I promote a release bundle version to production?
      - Can I overwrite existing artifacts when promoting a bundle?
      instructions:
      - text: Promote release bundle {release_bundle_name} {release_bundle_version} to {environment}.
        slots:
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          environment: requestBody.environment
      - text: Promote {release_bundle_name} {release_bundle_version} to {environment} including only repos {included_repository_keys}.
        slots:
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          environment: requestBody.environment
          included_repository_keys: requestBody.included_repository_keys
      method: generated
      generated: '2026-10-01'