Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Assets API

8 actions 8 updates phrasing extends openapi/conga-assets-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['/api/asset/v1/assets'].get
$.paths['/api/asset/v1/assets/group-summary'].get
$.paths['/api/asset/v1/assets/related-purchases'].post
$.paths['/api/asset/v1/assets/{cartId}'].get
$.paths['/api/asset/v1/terminate-preview'].post
$.paths['/api/asset/v1/{assetId}/coterm'].get
$.paths['/api/asset/v1/{parentAssetId}/assets'].get

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 Assets API
  version: 1.0.0
extends: openapi/conga-assets-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['/api/asset/v1/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's asset line items
      effect: read
      questions:
      - What products and subscriptions does a customer account currently own?
      - Can I search a customer's assets by product name and show only top-level bundles?
      instructions:
      - text: List asset line items for accounts {accountIds}.
        slots:
          accountIds: query.accountIds
      - text: Find assets on accounts {accountIds} matching product {productSearchString}.
        slots:
          accountIds: query.accountIds
          productSearchString: query.productSearchString
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/group-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize assets grouped by a field
      effect: read
      questions:
      - Can I see a customer's assets rolled up by a field such as product family?
      - How do I get a grouped summary of asset line items?
      instructions:
      - text: Summarize assets for accounts {accountIds} grouped by {groupingField}.
        slots:
          accountIds: query.accountIds
          groupingField: query.groupingField
      - text: Group asset line items by {groupingField}.
        slots:
          groupingField: query.groupingField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/related-purchases'].post
  update:
    x-apievangelist-phrasing:
      intent: List purchases related to given assets
      effect: read
      questions:
      - What other purchases are related to a set of assets?
      - Can I page through related purchased assets and filter them by product?
      instructions:
      - text: List related purchased assets for these asset IDs.
      - text: Show related purchases matching product {productSearchString}, page {page}.
        slots:
          productSearchString: query.productSearchString
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset line items in a cart's context
      effect: read
      questions:
      - Which existing assets are available to amend inside a particular cart?
      - Can I list the assets tied to a cart with attributes included?
      instructions:
      - text: List asset line items for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show assets in cart {cartId} for accounts {accountIds} with attributes.
        slots:
          cartId: path.cartId
          accountIds: query.accountIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/terminate-preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview the impact of terminating assets
      effect: read
      questions:
      - What would the financial impact be if we cancelled these assets on a date?
      - Can I preview termination metrics before actually terminating assets?
      instructions:
      - text: Preview termination of assets {AssetIds} on {AssetTerminationDate}.
        slots:
          AssetIds: requestBody.AssetIds
          AssetTerminationDate: requestBody.AssetTerminationDate
      - text: Calculate the metrics for ending assets {AssetIds} without terminating them.
        slots:
          AssetIds: requestBody.AssetIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/{assetId}/coterm'].get
  update:
    x-apievangelist-phrasing:
      intent: Find assets that co-terminate with an asset
      effect: read
      questions:
      - Which other assets on the account share the same end date criteria as this one?
      - How do I find co-terminating assets to amend together?
      instructions:
      - text: Find assets that co-terminate with asset {assetId}.
        slots:
          assetId: path.assetId
      - text: List co-term assets for {assetId} on account {accountId}.
        slots:
          assetId: path.assetId
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/{parentAssetId}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the child assets of a bundle
      effect: read
      questions:
      - What options and components sit inside a bundle asset?
      - Can I page through the child line items of a parent asset?
      instructions:
      - text: List child assets of bundle {parentAssetId}.
        slots:
          parentAssetId: path.parentAssetId
      - text: Show the option and secondary assets under {parentAssetId}, page {page}.
        slots:
          parentAssetId: path.parentAssetId
          page: query.page
      method: generated
      generated: '2026-10-01'