JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Release Lifecycle Management REST Release Bundles V2…

5 actions 5 updates phrasing extends openapi/jfrog-release-bundles-v2-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['/v2/release_bundle'].post
$.paths['/v2/release_bundle/records'].get
$.paths['/v2/release_bundle/records/{name}/{version}'].get
$.paths['/v2/release_bundle/records/{name}/{version}'].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 Release Lifecycle Management REST Release Bundles V2…
  version: 1.0.0
extends: openapi/jfrog-release-bundles-v2-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['/v2/release_bundle'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a v2 release bundle
      effect: write
      questions:
      - How do I create a v2 release bundle from builds or artifacts?
      - Can I skip Docker manifest resolution when creating a v2 release bundle?
      instructions:
      - text: Create v2 release bundle {release_bundle_name} version {release_bundle_version} from {source_type} source {source}.
        slots:
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          source_type: requestBody.source_type
          source: requestBody.source
      - text: Build v2 bundle {release_bundle_name} {release_bundle_version} from {source_type} {source} with skip_docker_manifest_resolution {skip}.
        slots:
          skip: requestBody.skip_docker_manifest_resolution
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          source_type: requestBody.source_type
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/release_bundle/records'].get
  update:
    x-apievangelist-phrasing:
      intent: List v2 release bundle records
      effect: read
      questions:
      - Which v2 release bundles exist?
      - Can I filter v2 release bundle records by name?
      instructions:
      - text: List all v2 release bundle records.
      - text: List v2 release bundles named {name}, up to {limit} results.
        slots:
          name: query.name
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/release_bundle/records/{name}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a v2 release bundle version
      effect: read
      questions:
      - What is in a specific v2 release bundle version?
      - Can I fetch one v2 release bundle record by name and version?
      instructions:
      - text: Get v2 release bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Show me the record for v2 bundle {name} at {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/release_bundle/records/{name}/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a v2 release bundle version
      effect: destructive
      questions:
      - Can I delete a v2 release bundle version?
      - How do I remove one version of a v2 release bundle record?
      instructions:
      - text: Delete v2 release bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Remove version {version} of the v2 bundle {name}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'