G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Snippets API

2 actions 2 updates phrasing extends openapi/g2-snippets-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 2

$.info

$.paths['/api/v2/products/{product_id}/snippets'].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 G2 Snippets API
  version: 1.0.0
extends: openapi/g2-snippets-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['/api/v2/products/{product_id}/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List review snippets for a product
      effect: read
      questions:
      - Can I get short quotable review snippets for my product?
      - Which review snippets come from a given industry or role?
      - Are there snippets tagged with a specific theme?
      instructions:
      - text: List review snippets for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show snippets for {product_id} tagged {tags}.
        slots:
          product_id: path.product_id
          tags: query.filter[tags]
      - text: Get snippets for {product_id} from {industry} reviewers.
        slots:
          product_id: path.product_id
          industry: query.filter[industry]
      method: generated
      generated: '2026-10-01'