Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Attributes API

8 actions 8 updates phrasing extends openapi/conga-attributes-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['/attributes'].get
$.paths['/attributes'].post
$.paths['/attributes'].delete
$.paths['/attributes'].patch
$.paths['/attributes/{Id}'].get
$.paths['/attributes/{Id}'].delete
$.paths['/attributes/{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 Attributes API
  version: 1.0.0
extends: openapi/conga-attributes-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['/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List product attributes
      effect: read
      questions:
      - Where can I see every attribute defined in my Conga admin setup?
      - Can I filter and sort the attribute list or page through it in smaller chunks?
      - What attributes exist right now, and which related records can be included?
      instructions:
      - text: List all attributes.
      - text: Show attributes matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      - text: Get page {page} of attributes with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create attributes
      effect: write
      questions:
      - How do I add new attributes to the catalog administration?
      - Can I create several attributes in a single request?
      instructions:
      - text: Create a batch of new attributes from the details I give you.
      - text: Add these new attribute records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several attributes at once
      effect: destructive
      questions:
      - How can I bulk-remove a set of attributes by their IDs?
      - Is there a way to delete many attributes in one call instead of one by one?
      instructions:
      - text: Delete this list of attribute IDs in one go.
      - text: Bulk-remove the attributes I'm sending in the request body.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several attributes at once
      effect: write
      questions:
      - Can I update fields on many attribute records in one request?
      - What's the way to bulk-edit a group of attributes?
      instructions:
      - text: Apply these field changes across multiple attributes at once.
      - text: Bulk-update the attribute records in this payload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single attribute
      effect: read
      questions:
      - How do I look up one attribute's full record by its ID?
      - Can I pull a specific attribute along with its related includes?
      instructions:
      - text: Show me attribute {Id}.
        slots:
          Id: path.Id
      - text: Fetch attribute {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one attribute by ID
      effect: destructive
      questions:
      - How do I remove a single attribute when I know its ID?
      - What happens when I delete just one attribute record?
      instructions:
      - text: Delete attribute {Id}.
        slots:
          Id: path.Id
      - text: Remove the single attribute with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attributes/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one attribute by ID
      effect: write
      questions:
      - How do I change fields on one specific attribute?
      - Can I edit a single attribute record without touching the others?
      instructions:
      - text: Update attribute {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit only the attribute whose ID is {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'