Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Product Information API

8 actions 8 updates phrasing extends openapi/conga-product-information-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/products/{ParentId}/information'].get
$.paths['/products/{ParentId}/information'].post
$.paths['/products/{ParentId}/information'].delete
$.paths['/products/{ParentId}/information'].patch
$.paths['/products/{ParentId}/information/{Id}'].get
$.paths['/products/{ParentId}/information/{Id}'].delete
$.paths['/products/{ParentId}/information/{Id}'].patch

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 Administration Product Information API
  version: 1.0.0
extends: openapi/conga-product-information-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: 7
- target: $.paths['/products/{ParentId}/information'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's information documents
      effect: read
      questions:
      - How do I see all the information documents attached to a product?
      - Can I filter or sort a product's information documents?
      - What product information does Conga hold for one of my products?
      instructions:
      - text: List the information documents for product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: List information documents on product {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information'].post
  update:
    x-apievangelist-phrasing:
      intent: Add information documents to a product
      effect: write
      questions:
      - How do I attach new information documents to a product?
      - Can I create several product information entries at once?
      instructions:
      - text: Create new information documents for product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add these product information entries to product {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product's information documents in bulk
      effect: destructive
      questions:
      - Is there a way to remove several information documents from a product at once?
      - Can I bulk delete product information under one product?
      instructions:
      - text: Delete these information documents from product {ParentId} in bulk.
        slots:
          ParentId: path.ParentId
      - text: Remove several product information entries under product {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product's information documents in bulk
      effect: write
      questions:
      - How do I edit many information documents on a product in one go?
      - Can I change specific fields across several product information documents?
      instructions:
      - text: Update several information documents on product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk edit fields on the information documents of product {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product information document
      effect: read
      questions:
      - How do I fetch a single information document for a product by its ID?
      - What is in one specific product information document?
      instructions:
      - text: Get information document {Id} for product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show product information record {Id} under product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one product information document
      effect: destructive
      questions:
      - How do I delete a single information document from a product?
      - Can I remove just one product information record by ID?
      instructions:
      - text: Delete information document {Id} from product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove the single product information record {Id} on product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/information/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one product information document
      effect: write
      questions:
      - What's the call to edit a single product information document?
      - Can I change one information record on a product without touching the others?
      instructions:
      - text: Update information document {Id} on product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit the single product information record {Id} under product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'