JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST Replication API

5 actions 5 updates phrasing extends openapi/jfrog-replication-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/replications'].get

$.paths['/api/replications/{repoKey}'].get

$.paths['/api/replications/{repoKey}'].put

$.paths['/api/replications/{repoKey}'].delete

OpenAPI Overlay

# 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 Replication API
  version: 1.0.0
extends: openapi/jfrog-replication-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/replications'].get
  update:
    x-apievangelist-phrasing:
      intent: List replication configurations
      effect: read
      questions:
      - Which repositories have replication set up?
      - Can I see every replication configuration at once?
      instructions:
      - text: List all replication configurations.
      - text: Show every repository replication.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/replications/{repoKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's replication config
      effect: read
      questions:
      - How is replication configured for a specific repository?
      - What cron schedule does a repo's replication use?
      instructions:
      - text: Show replication for repository {repoKey}.
        slots:
          repoKey: path.repoKey
      - text: Get the replication schedule of {repoKey}.
        slots:
          repoKey: path.repoKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/replications/{repoKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace repository replication
      effect: write
      questions:
      - How do I set up scheduled replication of a repository to another URL?
      - Can replication also sync deletes and properties?
      instructions:
      - text: Replicate repository {repoKey} to {url} on schedule {cronExp}.
        slots:
          repoKey: path.repoKey
          url: requestBody.url
          cronExp: requestBody.cronExp
      - text: Set replication for {repoKey} with sync deletes {syncDeletes}.
        slots:
          repoKey: path.repoKey
          syncDeletes: requestBody.syncDeletes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/replications/{repoKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository's replication
      effect: destructive
      questions:
      - How do I stop replicating a repository?
      - Can I remove the replication configuration from a repo?
      instructions:
      - text: Delete replication for {repoKey}.
        slots:
          repoKey: path.repoKey
      - text: Stop replicating repository {repoKey}.
        slots:
          repoKey: path.repoKey
      method: generated
      generated: '2026-10-01'