JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST Repositories API

6 actions 6 updates phrasing extends openapi/jfrog-repositories-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['/api/repositories'].get

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

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

$.paths['/api/repositories/{repoKey}'].post

$.paths['/api/repositories/{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 Repositories API
  version: 1.0.0
extends: openapi/jfrog-repositories-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['/api/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List repositories
      effect: read
      questions:
      - Which repositories exist in my Artifactory instance?
      - Can I list only remote repositories, or only Docker ones?
      instructions:
      - text: List all repositories.
      - text: List {type} repositories of package type {packageType}.
        slots:
          type: query.type
          packageType: query.packageType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/repositories/{repoKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's configuration
      effect: read
      questions:
      - How do I see the full configuration of one repository?
      - What include and exclude patterns does a repository use?
      instructions:
      - text: Show the configuration of repository {repoKey}.
        slots:
          repoKey: path.repoKey
      - text: Get repo {repoKey}'s settings.
        slots:
          repoKey: path.repoKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/repositories/{repoKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a repository
      effect: write
      questions:
      - How do I create a new local Maven repository?
      - Can I enable Xray indexing when creating a repository?
      instructions:
      - text: Create {rclass} repository {repoKey} for {packageType} packages.
        slots:
          rclass: requestBody.rclass
          repoKey: path.repoKey
          packageType: requestBody.packageType
      - text: Create repo {repoKey} with key {key}, class {rclass}, type {packageType}, Xray indexing {xrayIndex}.
        slots:
          repoKey: path.repoKey
          key: requestBody.key
          rclass: requestBody.rclass
          packageType: requestBody.packageType
          xrayIndex: requestBody.xrayIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/repositories/{repoKey}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a repository's configuration
      effect: write
      questions:
      - How do I black out an existing repository?
      - Can I change the description of a repository I already have?
      instructions:
      - text: Update existing repository {repoKey} with description {description}.
        slots:
          repoKey: path.repoKey
          description: requestBody.description
      - text: 'Black out existing repo {repoKey}: set blackedOut to {blackedOut}.'
        slots:
          repoKey: path.repoKey
          blackedOut: requestBody.blackedOut
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/repositories/{repoKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository
      effect: destructive
      questions:
      - How do I delete a repository I no longer use?
      - Does removing a repository also delete its content?
      instructions:
      - text: Delete repository {repoKey}.
        slots:
          repoKey: path.repoKey
      - text: Remove repo {repoKey} and its configuration.
        slots:
          repoKey: path.repoKey
      method: generated
      generated: '2026-10-01'