G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Product Mappings API

4 actions 4 updates phrasing extends openapi/g2-product-mappings-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/product_mappings'].get

$.paths['/api/v2/product_mappings'].post

$.paths['/api/v2/product_mappings/{id}'].put

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 Product Mappings API
  version: 1.0.0
extends: openapi/g2-product-mappings-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/product_mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List product mappings to external IDs
      effect: read
      questions:
      - Which of my external IDs are mapped to G2 products?
      - Can I find the mapping for a specific external ID?
      - What product mappings were deleted after a given date?
      instructions:
      - text: List all product mappings.
      - text: Find the product mapping for external ID {external_id}.
        slots:
          external_id: query.filter[external_id]
      - text: Show mappings for product {product_id}.
        slots:
          product_id: query.filter[product_id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/product_mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a product to an external ID
      effect: write
      questions:
      - How do I link a product to an ID in my own system?
      - Can I add a new mapping between a listing and my internal record?
      instructions:
      - text: Create a product mapping with {data}.
        slots:
          data: requestBody.data
      - text: Add a new external ID mapping using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/product_mappings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing product mapping
      effect: write
      questions:
      - Can I change the external ID on a mapping I already created?
      - What's the way to correct an existing product mapping?
      instructions:
      - text: Update product mapping {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit existing mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'