G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Screenshots API

4 actions 4 updates phrasing extends openapi/g2-screenshots-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/screenshots'].get
$.paths['/api/v2/screenshots/{id}'].get
$.paths['/api/v2/products/{product_id}/screenshots'].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 Screenshots API
  version: 1.0.0
extends: openapi/g2-screenshots-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/screenshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List all screenshots
      effect: read
      questions:
      - Can I browse every product screenshot in the catalog?
      - Which screenshots were uploaded after a certain date across all products?
      instructions:
      - text: List all screenshots.
      - text: Show screenshots created after {date}.
        slots:
          date: query.filter[created_at_gt]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/screenshots/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one screenshot
      effect: read
      questions:
      - Can I fetch a single screenshot by its ID?
      - What details are stored for one screenshot?
      instructions:
      - text: Show screenshot {id}.
        slots:
          id: path.id
      - text: Get screenshot {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/products/{product_id}/screenshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's screenshots
      effect: read
      questions:
      - What screenshots are on a specific product's listing?
      - Can I see a product's screenshots updated recently?
      instructions:
      - text: List screenshots for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show screenshots of {product_id} updated after {date}.
        slots:
          product_id: path.product_id
          date: query.filter[updated_at_gt]
      method: generated
      generated: '2026-10-01'