G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Reviews API

4 actions 4 updates phrasing extends openapi/g2-reviews-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 4

$.info

$.paths['/api/v2/products/{product_id}/reviews'].get

$.paths['/api/v2/users/me/products/{product_id}/review'].get

$.paths['/api/v2/users/me/products/{product_id}/review'].post

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 Reviews API
  version: 1.0.0
extends: openapi/g2-reviews-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: 3
- target: $.paths['/api/v2/products/{product_id}/reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List reviews of a product
      effect: read
      questions:
      - What are reviewers saying about a product?
      - Can I filter a product's reviews by company size, country or role?
      - Which reviews of my product were updated since last week?
      instructions:
      - text: List reviews for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show reviews of {product_id} from {segment} companies.
        slots:
          product_id: path.product_id
          segment: query.filter[company_segment][]
      - text: Get reviews of {product_id} updated after {date}.
        slots:
          product_id: path.product_id
          date: query.filter[updated_at_gt]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/products/{product_id}/review'].get
  update:
    x-apievangelist-phrasing:
      intent: View my own review of a product
      effect: read
      questions:
      - What did I write in my review of a product I own?
      - Can I retrieve the review I personally left for a product?
      instructions:
      - text: Show my review of product {product_id}.
        slots:
          product_id: path.product_id
      - text: Get the review I wrote for {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/products/{product_id}/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit or update my product review
      effect: write
      questions:
      - How do I submit a review for a product I use?
      - Can I revise a review I already submitted by answering the questions again?
      instructions:
      - text: Submit my review of product {product_id} with answers {answers}.
        slots:
          product_id: path.product_id
          answers: requestBody.answers
      - text: Update my review of {product_id} with {answers}, accepting the terms.
        slots:
          product_id: path.product_id
          answers: requestBody.answers
      method: generated
      generated: '2026-10-01'