G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Vendors API

3 actions 3 updates phrasing extends openapi/g2-vendors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for G2's API. It is a proposal applied on top of the contract, not a document G2 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v2/vendors'].get
$.paths['/api/v2/vendors/{id}'].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 G2 Vendors API
  version: 1.0.0
extends: openapi/g2-vendors-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: 2
- target: $.paths['/api/v2/vendors'].get
  update:
    x-apievangelist-phrasing:
      intent: List software vendors
      effect: read
      questions:
      - What software vendors are listed?
      - Which vendors were added after a certain date?
      instructions:
      - text: List all vendors.
      - text: Show vendors created after {date}.
        slots:
          date: query.filter[created_at_gt]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/vendors/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one vendor
      effect: read
      questions:
      - What details are stored about a single vendor?
      - Can I fetch one vendor record by its ID?
      instructions:
      - text: Show vendor {id}.
        slots:
          id: path.id
      - text: Get vendor {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'