JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Artifactory REST System & Configuration API

6 actions 6 updates phrasing extends openapi/jfrog-system-configuration-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/system/ping'].get

$.paths['/api/system/version'].get

$.paths['/api/system/configuration'].get

$.paths['/api/system/configuration'].patch

$.paths['/api/system/licenses'].get

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 System & Configuration API
  version: 1.0.0
extends: openapi/jfrog-system-configuration-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/system/ping'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that Artifactory is reachable
      effect: read
      questions:
      - Is my Artifactory instance up and responding?
      - What's the quickest health check for Artifactory?
      instructions:
      - text: Ping Artifactory.
      - text: Check whether Artifactory is reachable.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Artifactory version
      effect: read
      questions:
      - Which Artifactory version and build am I running?
      - Can I check the version of my Artifactory instance via API?
      instructions:
      - text: Show the Artifactory version.
      - text: Get Artifactory's version and build info.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/system/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the system configuration descriptor
      effect: read
      questions:
      - How do I export Artifactory's full system configuration as XML?
      - Where can I read the global configuration descriptor?
      instructions:
      - text: Download the Artifactory system configuration XML.
      - text: Show the full global configuration descriptor.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/system/configuration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch the system configuration with YAML
      effect: write
      questions:
      - How do I apply a partial configuration change to Artifactory using YAML?
      - Can I change one global setting without uploading the whole descriptor?
      instructions:
      - text: Apply this YAML patch to the Artifactory system configuration.
      - text: Patch the global configuration with my YAML snippet.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/system/licenses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get installed license details
      effect: read
      questions:
      - What license is installed on my Artifactory instance?
      - When does my Artifactory license expire?
      instructions:
      - text: Show the installed Artifactory license.
      - text: Get license details for this instance.
      method: generated
      generated: '2026-10-01'