G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Research Boards API

11 actions 11 updates phrasing extends openapi/g2-research-boards-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 11

$.info
$.paths['/api/v2/users/me/research_boards'].get
$.paths['/api/v2/users/me/research_boards'].post
$.paths['/api/v2/users/me/research_boards/{uuid}'].get
$.paths['/api/v2/users/me/research_boards/{uuid}'].delete
$.paths['/api/v2/users/me/research_boards/{uuid}'].patch
$.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products'].get
$.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products'].post
$.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/batch_create'].post
$.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/batch_destroy'].post
$.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/{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 Research Boards API
  version: 1.0.0
extends: openapi/g2-research-boards-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: 10
- target: $.paths['/api/v2/users/me/research_boards'].get
  update:
    x-apievangelist-phrasing:
      intent: List my research boards
      effect: read
      questions:
      - What research boards have I saved?
      - Can I page through all my software research boards?
      instructions:
      - text: List my research boards.
      - text: Show my research boards, {page_size} per page.
        slots:
          page_size: query.page[size]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a research board
      effect: write
      questions:
      - How do I start a new board to compare software I'm researching?
      - Can I make a fresh shortlist board for a buying project?
      instructions:
      - text: Create a research board with {data}.
        slots:
          data: requestBody.data
      - text: Start a new shortlist board.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a research board
      effect: read
      questions:
      - What's saved on one of my research boards?
      - Can I open a specific research board by its ID?
      instructions:
      - text: Show research board {uuid}.
        slots:
          uuid: path.uuid
      - text: Open my board {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a research board
      effect: destructive
      questions:
      - Can I permanently remove a research board I no longer need?
      - What happens to a board's shortlist when I delete the whole board?
      instructions:
      - text: Delete research board {uuid}.
        slots:
          uuid: path.uuid
      - text: Remove my entire board {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{uuid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a research board
      effect: write
      questions:
      - Can I rename one of my research boards?
      - How do I change the details of an existing board?
      instructions:
      - text: Update research board {uuid} with {data}.
        slots:
          uuid: path.uuid
          data: requestBody.data
      - text: Rename board {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products on a research board
      effect: read
      questions:
      - Which products have I added to a research board?
      - What tools are on my shortlist board right now?
      instructions:
      - text: List products on research board {research_board_uuid}.
        slots:
          research_board_uuid: path.research_board_uuid
      - text: Show what's shortlisted on board {research_board_uuid}.
        slots:
          research_board_uuid: path.research_board_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add one product to a research board
      effect: write
      questions:
      - Can I save a single product to my research board?
      - How do I put one tool on my shortlist?
      instructions:
      - text: Add a product to research board {research_board_uuid} using {data}.
        slots:
          research_board_uuid: path.research_board_uuid
          data: requestBody.data
      - text: Save one product to board {research_board_uuid}.
        slots:
          research_board_uuid: path.research_board_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/batch_create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several products to a research board
      effect: write
      questions:
      - Can I add many products to a research board at once?
      - Is there a bulk way to fill my shortlist with several tools?
      instructions:
      - text: Bulk add products {data} to research board {research_board_uuid}.
        slots:
          data: requestBody.data
          research_board_uuid: path.research_board_uuid
      - text: Add multiple products to board {research_board_uuid} in one go.
        slots:
          research_board_uuid: path.research_board_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/batch_destroy'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove several products from a research board
      effect: destructive
      questions:
      - Can I clear several products off a research board at once?
      - Is there a bulk way to drop multiple tools from my shortlist?
      instructions:
      - text: Bulk remove products {data} from research board {research_board_uuid}.
        slots:
          data: requestBody.data
          research_board_uuid: path.research_board_uuid
      - text: Drop multiple products from board {research_board_uuid} in one go.
        slots:
          research_board_uuid: path.research_board_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users/me/research_boards/{research_board_uuid}/products/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one product from a research board
      effect: destructive
      questions:
      - Can I take a single product off my research board?
      - What's the way to drop just one tool from my shortlist?
      instructions:
      - text: Remove product {id} from research board {research_board_uuid}.
        slots:
          id: path.id
          research_board_uuid: path.research_board_uuid
      - text: Take {id} off board {research_board_uuid}.
        slots:
          id: path.id
          research_board_uuid: path.research_board_uuid
      method: generated
      generated: '2026-10-01'