JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Xray REST Ignore Rules API

5 actions 5 updates phrasing extends openapi/jfrog-ignore-rules-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 5

$.info

$.paths['/v1/ignore_rules'].get

$.paths['/v1/ignore_rules'].post

$.paths['/v1/ignore_rules/{ruleId}'].get

$.paths['/v1/ignore_rules/{ruleId}'].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 Xray REST Ignore Rules API
  version: 1.0.0
extends: openapi/jfrog-ignore-rules-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: 4
- target: $.paths['/v1/ignore_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Xray ignore rules
      effect: read
      questions:
      - What ignore rules are configured in Xray?
      - Can I see which vulnerabilities are currently being ignored?
      instructions:
      - text: List all Xray ignore rules.
      - text: Show every ignored vulnerability and license rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ignore_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Xray ignore rule
      effect: write
      questions:
      - How do I ignore a specific CVE in Xray until a set date?
      - Can I ignore a license violation for one component only?
      instructions:
      - text: Ignore CVEs {cves} until {expiration_date}.
        slots:
          cves: requestBody.cves
          expiration_date: requestBody.expiration_date
      - text: Create an ignore rule for licenses {licenses} on component {component} with note {notes}.
        slots:
          licenses: requestBody.licenses
          component: requestBody.component
          notes: requestBody.notes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ignore_rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Xray ignore rule
      effect: read
      questions:
      - How do I see what one ignore rule covers?
      - When does a particular ignore rule expire?
      instructions:
      - text: Show ignore rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Get the details of Xray ignore rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ignore_rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Xray ignore rule
      effect: destructive
      questions:
      - How do I stop ignoring a vulnerability in Xray?
      - Can I delete an ignore rule by its ID?
      instructions:
      - text: Delete ignore rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove Xray ignore rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'