G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Medals API

2 actions 2 updates phrasing extends openapi/g2-medals-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}/badges'].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 Medals API
  version: 1.0.0
extends: openapi/g2-medals-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}/badges'].get
  update:
    x-apievangelist-phrasing:
      intent: List badges a product has won
      effect: read
      questions:
      - What badges or medals has a product been awarded on G2?
      - Can I see which medals a product won in a specific season and year?
      - Which awards did my product earn within one category?
      instructions:
      - text: List medals for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show badges for {product_id} from {season} {year}.
        slots:
          product_id: path.product_id
          season: query.filter[season]
          year: query.filter[year]
      - text: Get medals for {product_id} in category {category_id}.
        slots:
          product_id: path.product_id
          category_id: query.filter[category_id]
      method: generated
      generated: '2026-10-01'