G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Categories API

3 actions 3 updates phrasing extends openapi/g2-categories-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/categories'].get

$.paths['/api/v2/categories/{id}'].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 Categories API
  version: 1.0.0
extends: openapi/g2-categories-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/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse software categories
      effect: read
      questions:
      - What software categories does G2 have?
      - Can I find categories whose name contains a keyword like CRM?
      - Which categories were added or changed since a given date?
      instructions:
      - text: List all software categories.
      - text: Find categories with names containing {name}.
        slots:
          name: query.filter[name_cont]
      - text: List categories updated after {date}.
        slots:
          date: query.filter[updated_at_gt]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one software category
      effect: read
      questions:
      - What details are stored for a single software category?
      - Can I fetch one category record by its ID along with related data?
      instructions:
      - text: Show category {id}.
        slots:
          id: path.id
      - text: Get category {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'