JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Distribution REST Release Bundles V1 API

7 actions 7 updates phrasing extends openapi/jfrog-release-bundles-v1-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 7

$.info
$.paths['/v1/release_bundle'].get
$.paths['/v1/release_bundle'].post
$.paths['/v1/release_bundle/{name}/{version}'].get
$.paths['/v1/release_bundle/{name}/{version}'].put
$.paths['/v1/release_bundle/{name}/{version}'].delete
$.paths['/v1/release_bundle/{name}/{version}/sign'].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 Distribution REST Release Bundles V1 API
  version: 1.0.0
extends: openapi/jfrog-release-bundles-v1-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: 6
- target: $.paths['/v1/release_bundle'].get
  update:
    x-apievangelist-phrasing:
      intent: List release bundles
      effect: read
      questions:
      - Which release bundles have been created for distribution?
      - Can I see every release bundle in one list?
      instructions:
      - text: List all release bundles.
      - text: Show me every release bundle available for distribution.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/release_bundle'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release bundle
      effect: write
      questions:
      - How do I package a set of artifacts into a release bundle for distribution?
      - Can I sign a release bundle immediately when I create it?
      instructions:
      - text: Create release bundle {name} version {version} from spec {spec}.
        slots:
          name: requestBody.name
          version: requestBody.version
          spec: requestBody.spec
      - text: Dry-run creating release bundle {name} {version} with spec {spec} and dry_run {dry_run}.
        slots:
          name: requestBody.name
          version: requestBody.version
          spec: requestBody.spec
          dry_run: requestBody.dry_run
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/release_bundle/{name}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release bundle version
      effect: read
      questions:
      - What artifacts and release notes are in a given release bundle version?
      - Can I check the details of one release bundle version?
      instructions:
      - text: Get release bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Show me the contents of release bundle {name} at version {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/release_bundle/{name}/{version}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a release bundle
      effect: write
      questions:
      - Can I change a release bundle's release notes before signing it?
      - How do I update the artifact spec of an unsigned release bundle?
      instructions:
      - text: Update release bundle {name} {version} with release notes {release_notes}.
        slots:
          name: path.name
          version: path.version
          release_notes: requestBody.release_notes
      - text: Replace the spec of release bundle {name} version {version} with {spec}.
        slots:
          name: path.name
          version: path.version
          spec: requestBody.spec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/release_bundle/{name}/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release bundle version
      effect: destructive
      questions:
      - Can I delete a release bundle version I created by mistake?
      - What do I need to remove a specific release bundle version?
      instructions:
      - text: Delete release bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Remove version {version} of release bundle {name}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/release_bundle/{name}/{version}/sign'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a release bundle
      effect: write
      questions:
      - How do I make a release bundle immutable so it can be distributed?
      - What does signing a release bundle do?
      instructions:
      - text: Sign release bundle {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Lock and sign version {version} of release bundle {name} for distribution.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'