JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST Properties API

4 actions 4 updates phrasing extends openapi/jfrog-properties-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 4

$.info

$.paths['/api/storage/{repoKey}/{itemPath}?properties'].get

$.paths['/api/storage/{repoKey}/{itemPath}?properties'].put

$.paths['/api/storage/{repoKey}/{itemPath}?properties'].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 Properties API
  version: 1.0.0
extends: openapi/jfrog-properties-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: 3
- target: $.paths['/api/storage/{repoKey}/{itemPath}?properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get properties on an artifact or folder
      effect: read
      questions:
      - What properties are set on a given artifact?
      - How do I read a folder's metadata properties?
      instructions:
      - text: Show properties on {itemPath} in {repoKey}.
        slots:
          itemPath: path.itemPath
          repoKey: path.repoKey
      - text: Get the properties of artifact {repoKey}/{itemPath}.
        slots:
          repoKey: path.repoKey
          itemPath: path.itemPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/storage/{repoKey}/{itemPath}?properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Set properties on an artifact or folder
      effect: write
      questions:
      - How do I tag an artifact with custom properties?
      - Can I set properties recursively on everything in a folder?
      instructions:
      - text: Set properties {properties} on {repoKey}/{itemPath}.
        slots:
          properties: query.properties
          repoKey: path.repoKey
          itemPath: path.itemPath
      - text: Apply properties {properties} to folder {itemPath} in {repoKey}, recursive {recursive}.
        slots:
          properties: query.properties
          itemPath: path.itemPath
          repoKey: path.repoKey
          recursive: query.recursive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/storage/{repoKey}/{itemPath}?properties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove properties from an artifact or folder
      effect: destructive
      questions:
      - How do I delete a property from an artifact?
      - Can I remove several properties from a folder at once?
      instructions:
      - text: Remove properties {properties} from {repoKey}/{itemPath}.
        slots:
          properties: query.properties
          repoKey: path.repoKey
          itemPath: path.itemPath
      - text: Delete property {properties} on {itemPath} in {repoKey}.
        slots:
          properties: query.properties
          itemPath: path.itemPath
          repoKey: path.repoKey
      method: generated
      generated: '2026-10-01'