JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jfrog System API

8 actions 8 updates phrasing extends openapi/jfrog-system-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 8

$.info
$.paths['/api/v1/system/ping'].get
$.paths['/api/v1/system/version'].get
$.paths['/v1/system/ping'].get
$.paths['/v1/system/version'].get
$.paths['/v1/system/info'].get
$.paths['/router/api/v1/system/ping'].get
$.paths['/router/api/v1/system/health'].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 System API
  version: 1.0.0
extends: openapi/jfrog-system-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: 7
- target: $.paths['/api/v1/system/ping'].get
  update:
    x-apievangelist-phrasing:
      intent: Ping the Access service
      effect: read
      questions:
      - Is the Access service up and responding?
      - How can I health-check just the Access service?
      instructions:
      - text: Ping the Access service.
      - text: Check that the Access service is operational.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Access service version
      effect: read
      questions:
      - Which version and revision of the Access service am I running?
      - Can I find the Access service's build revision?
      instructions:
      - text: Get the Access service version.
      - text: Show me the Access service's version and revision.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/system/ping'].get
  update:
    x-apievangelist-phrasing:
      intent: Ping a service's /v1 health endpoint
      effect: read
      questions:
      - Is the service behind the /v1/system/ping endpoint responding?
      - Can I do a quick health check on the /v1 service ping rather than the router?
      instructions:
      - text: Ping the /v1/system/ping health endpoint.
      - text: Run the /v1 service health ping.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Mission Control version
      effect: read
      questions:
      - What version of Mission Control is installed?
      - Can I check Mission Control's version information?
      instructions:
      - text: Get the Mission Control version.
      - text: Show me which Mission Control release is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/system/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Pipelines system info
      effect: read
      questions:
      - Which version of JFrog Pipelines is running?
      - Can I see Pipelines system information?
      instructions:
      - text: Get Pipelines system information.
      - text: Show me the Pipelines version and system info.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/router/api/v1/system/ping'].get
  update:
    x-apievangelist-phrasing:
      intent: Ping the platform router
      effect: read
      questions:
      - Is the platform router reachable?
      - How do I health-check the router that fronts the platform?
      instructions:
      - text: Ping the platform router.
      - text: Check that the router is responding.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/router/api/v1/system/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health of all platform services
      effect: read
      questions:
      - Are all of the platform's services healthy right now?
      - Which services on my platform are reporting problems?
      instructions:
      - text: Get the health status of every platform service.
      - text: Show me which platform services are healthy and which are not.
      method: generated
      generated: '2026-10-01'