JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Xray REST Components API

2 actions 2 updates phrasing extends openapi/jfrog-components-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 2

$.info
$.paths['/v1/component'].post

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 Xray REST Components API
  version: 1.0.0
extends: openapi/jfrog-components-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: 1
- target: $.paths['/v1/component'].post
  update:
    x-apievangelist-phrasing:
      intent: Get vulnerabilities and licenses for components
      effect: read
      questions:
      - What known vulnerabilities affect a given open-source component?
      - Which licenses does a component carry according to Xray?
      instructions:
      - text: Get vulnerability and license details for components {component_details}.
        slots:
          component_details: requestBody.component_details
      - text: Check {component_details} for known CVEs and licenses.
        slots:
          component_details: requestBody.component_details
      method: generated
      generated: '2026-10-01'