JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jfrog Distribution API

6 actions 6 updates phrasing extends openapi/jfrog-distribution-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 6

$.info
$.paths['/v1/distribution/{name}/{version}'].post
$.paths['/v1/distribution/{name}/{version}/status'].get
$.paths['/v1/distribution/{name}/{version}/delete'].post
$.paths['/v2/release_bundle/distribute/{name}/{version}'].post
$.paths['/v2/release_bundle/distribute/{name}/{version}/status'].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 Distribution API
  version: 1.0.0
extends: openapi/jfrog-distribution-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: 5
- target: $.paths['/v1/distribution/{name}/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Distribute a signed release bundle (v1)
      effect: write
      questions:
      - How do I push a signed release bundle out to edge nodes with the v1 distribution endpoint?
      - Can I dry-run a v1 distribution before it actually ships?
      instructions:
      - text: Distribute release bundle {name} {version} via v1 using rules {distribution_rules}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
      - text: Dry-run the v1 distribution of {name} {version} with rules {distribution_rules}, dry run {dry_run}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
          dry_run: requestBody.dry_run
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/distribution/{name}/{version}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check v1 distribution status
      effect: read
      questions:
      - How do I check whether a v1 distribution reached its edge nodes?
      - What does the v1 status endpoint show for a release bundle version?
      instructions:
      - text: Show v1 distribution status for {name} {version}.
        slots:
          name: path.name
          version: path.version
      - text: Check the v1 distribution progress of bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/distribution/{name}/{version}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a release bundle from edge nodes
      effect: destructive
      questions:
      - How do I remove a distributed release bundle from edge nodes?
      - Can I dry-run deleting a bundle from edges first?
      instructions:
      - text: Delete release bundle {name} {version} from edges matching {distribution_rules}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
      - text: Dry-run removing {name} {version} from edge nodes, rules {distribution_rules}, dry run {dry_run}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
          dry_run: requestBody.dry_run
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/release_bundle/distribute/{name}/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Distribute a release bundle (v2)
      effect: write
      questions:
      - How do I distribute a v2 release bundle to edge nodes?
      - Can v2 distribution auto-create missing repositories on the edges?
      instructions:
      - text: Distribute v2 release bundle {name} {version} with rules {distribution_rules}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
      - text: Ship v2 bundle {name} {version} to edges using {distribution_rules}, auto-create repos {auto_create_missing_repositories}.
        slots:
          name: path.name
          version: path.version
          distribution_rules: requestBody.distribution_rules
          auto_create_missing_repositories: requestBody.auto_create_missing_repositories
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/release_bundle/distribute/{name}/{version}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check v2 release bundle distribution status
      effect: read
      questions:
      - How do I check the distribution status of a v2 release bundle?
      - Has my v2 bundle finished distributing to all edges?
      instructions:
      - text: Show v2 distribution status for release bundle {name} {version}.
        slots:
          name: path.name
          version: path.version
      - text: Check whether v2 bundle {name} version {version} has distributed.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'