G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Data Subscriptions API

4 actions 4 updates phrasing extends openapi/g2-data-subscriptions-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/partners/{partner_id}/data_subscriptions'].get
$.paths['/api/v2/partners/{partner_id}/data_subscriptions'].post
$.paths['/api/v2/partners/{partner_id}/data_subscriptions/{data_subscription_id}'].delete

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 Data Subscriptions API
  version: 1.0.0
extends: openapi/g2-data-subscriptions-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/partners/{partner_id}/data_subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's data subscriptions
      effect: read
      questions:
      - Which data subscriptions does my partner account have?
      - Can I page through all active data subscriptions for a partner ID?
      instructions:
      - text: List data subscriptions for partner {partner_id}.
        slots:
          partner_id: path.partner_id
      - text: Show {page_size} data subscriptions per page for partner {partner_id}.
        slots:
          page_size: query.page[size]
          partner_id: path.partner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/partners/{partner_id}/data_subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner data subscription
      effect: write
      questions:
      - How do I start a new data subscription as a partner?
      - Can I add another data subscription under my partner ID?
      instructions:
      - text: Create a data subscription for partner {partner_id} with {data}.
        slots:
          partner_id: path.partner_id
          data: requestBody.data
      - text: Subscribe partner {partner_id} to a new data feed using {data}.
        slots:
          partner_id: path.partner_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/partners/{partner_id}/data_subscriptions/{data_subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a partner data subscription
      effect: destructive
      questions:
      - Can I cancel a data subscription I no longer need?
      - What happens when a partner removes one of its data subscriptions?
      instructions:
      - text: Delete data subscription {data_subscription_id} for partner {partner_id}.
        slots:
          data_subscription_id: path.data_subscription_id
          partner_id: path.partner_id
      - text: Cancel subscription {data_subscription_id} on partner {partner_id}.
        slots:
          data_subscription_id: path.data_subscription_id
          partner_id: path.partner_id
      method: generated
      generated: '2026-10-01'