JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST Searches API

6 actions 6 updates phrasing extends openapi/jfrog-searches-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/search/aql'].post
$.paths['/api/search/gavc'].get
$.paths['/api/search/prop'].get
$.paths['/api/search/checksum'].get
$.paths['/api/search/latestVersion'].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 Artifactory REST Searches API
  version: 1.0.0
extends: openapi/jfrog-searches-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/search/aql'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an AQL query
      effect: read
      questions:
      - How do I query Artifactory with AQL for complex artifact searches?
      - Can I combine many criteria in one artifact search query?
      instructions:
      - text: Run this AQL query against Artifactory.
      - text: Execute an Artifactory Query Language search for my artifacts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/gavc'].get
  update:
    x-apievangelist-phrasing:
      intent: Search artifacts by Maven coordinates
      effect: read
      questions:
      - How do I find a Maven artifact by its group ID and artifact ID?
      - Can I limit a Maven coordinate search to certain repositories?
      instructions:
      - text: Find artifacts with group {g} and artifact {a}.
        slots:
          g: query.g
          a: query.a
      - text: Search for {g}:{a}:{v} in repositories {repos}.
        slots:
          g: query.g
          a: query.a
          v: query.v
          repos: query.repos
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/prop'].get
  update:
    x-apievangelist-phrasing:
      intent: Search artifacts by property values
      effect: read
      questions:
      - Which artifacts carry a particular property value?
      - Can I search for artifacts by their properties within specific repos?
      instructions:
      - text: Search artifacts by property in repositories {repos}.
        slots:
          repos: query.repos
      - text: Find artifacts tagged with matching properties.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/checksum'].get
  update:
    x-apievangelist-phrasing:
      intent: Find artifacts by checksum
      effect: read
      questions:
      - Where else is a file with this SHA-256 stored?
      - Can I locate an artifact by its SHA-1 or MD5?
      instructions:
      - text: Find artifacts with SHA-256 {sha256}.
        slots:
          sha256: query.sha256
      - text: Search repositories {repos} for checksum SHA-1 {sha1}.
        slots:
          repos: query.repos
          sha1: query.sha1
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/latestVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest version of an artifact
      effect: read
      questions:
      - What is the newest version of a given Maven group and artifact?
      - Can I check the latest artifact version only in certain repositories?
      instructions:
      - text: Get the latest version of {g}:{a}.
        slots:
          g: query.g
          a: query.a
      - text: Find the newest version of {g}:{a} in repositories {repos}.
        slots:
          g: query.g
          a: query.a
          repos: query.repos
      method: generated
      generated: '2026-10-01'