Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asset Actions API

11 actions 11 updates phrasing extends openapi/conga-assetactions-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 11

$.info
$.paths['/api/asset/v1/assets/{cartId}/change'].post
$.paths['/api/asset/v1/assets/{cartId}/change-configuration'].post
$.paths['/api/asset/v1/assets/{cartId}/change-quantity'].post
$.paths['/api/asset/v1/assets/{cartId}/renew'].post
$.paths['/api/asset/v1/assets/{cartId}/restore'].post
$.paths['/api/asset/v1/assets/{cartId}/resume'].post
$.paths['/api/asset/v1/assets/{cartId}/suspend'].post
$.paths['/api/asset/v1/assets/{cartId}/swap'].post
$.paths['/api/asset/v1/assets/{cartId}/terminate'].post
$.paths['/api/asset/v1/assets/{cartId}/termination-date'].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 Asset Actions API
  version: 1.0.0
extends: openapi/conga-assetactions-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/asset/v1/assets/{cartId}/change'].post
  update:
    x-apievangelist-phrasing:
      intent: Amend a customer's assets in a cart
      effect: write
      questions:
      - How do I bring existing assets into a cart so I can amend them?
      - Can I change several installed assets in one cart at once?
      instructions:
      - text: Change the listed assets in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Start an amendment of these assets using cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/change-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Reconfigure an asset
      effect: write
      questions:
      - How do I change the configuration of a product a customer already owns?
      - Can an asset reconfiguration take effect from a specific start date?
      instructions:
      - text: Reconfigure asset {AssetId} in cart {cartId}.
        slots:
          AssetId: requestBody.AssetId
          cartId: path.cartId
      - text: Change the configuration of asset {AssetId} effective {EffectiveStartDate} using cart {cartId}.
        slots:
          AssetId: requestBody.AssetId
          EffectiveStartDate: requestBody.EffectiveStartDate
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/change-quantity'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the quantity of assets
      effect: write
      questions:
      - How do I increase the number of seats on an asset a customer owns?
      - Does changing an asset's quantity update related implied quantities too?
      instructions:
      - text: Change the quantity of the listed assets in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Update asset quantities for this amendment in cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew assets
      effect: write
      questions:
      - How do I renew a customer's subscriptions for another term?
      - Can I renew assets at their existing price instead of repricing?
      instructions:
      - text: Renew assets {AssetIds} in cart {cartId} for term {RenewTerm}.
        slots:
          AssetIds: requestBody.AssetIds
          cartId: path.cartId
          RenewTerm: requestBody.RenewTerm
      - text: Renew assets {AssetIds} until {RenewEndDate} keeping the current asset price {useAssetPrice}, using cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          RenewEndDate: requestBody.RenewEndDate
          useAssetPrice: query.useAssetPrice
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore line items to their original asset values
      effect: write
      questions:
      - Can I undo edits to an amended line item and go back to the asset's values?
      - How do I reset line item fields to what the original asset had?
      instructions:
      - text: Restore line items in cart {cartId} to their original asset values.
        slots:
          cartId: path.cartId
      - text: Reset the amended line item fields in cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume suspended assets
      effect: write
      questions:
      - How do I reactivate a customer's suspended subscription?
      - Can I choose the date a suspended asset resumes?
      instructions:
      - text: Resume assets {AssetIds} in cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          cartId: path.cartId
      - text: Resume suspended assets {AssetIds} starting {StartDate} via cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          StartDate: requestBody.StartDate
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend assets for a period
      effect: write
      questions:
      - How do I pause a customer's subscription for a few months?
      - Can I set an end date so a suspended asset comes back automatically?
      instructions:
      - text: Suspend assets {AssetIds} from {StartDate} to {EndDate} in cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          StartDate: requestBody.StartDate
          EndDate: requestBody.EndDate
          cartId: path.cartId
      - text: Pause assets {AssetIds} for term {Term} using cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          Term: requestBody.Term
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/swap'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap an asset for another product
      effect: write
      questions:
      - How do I upgrade a customer from one product to an eligible replacement?
      - Can a product swap take effect on a future date?
      instructions:
      - text: Swap asset {AssetId} for product {ProductId} in cart {cartId}.
        slots:
          AssetId: requestBody.AssetId
          ProductId: requestBody.ProductId
          cartId: path.cartId
      - text: Replace asset {AssetId} with product {ProductId} effective {EffectiveSwapDate}, using cart {cartId}.
        slots:
          AssetId: requestBody.AssetId
          ProductId: requestBody.ProductId
          EffectiveSwapDate: requestBody.EffectiveSwapDate
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate assets
      effect: destructive
      questions:
      - How do I cancel a customer's subscription assets as of a date?
      - Can I end several assets at once through a cart?
      instructions:
      - text: Terminate assets {AssetIds} on {AssetTerminationDate} in cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          AssetTerminationDate: requestBody.AssetTerminationDate
          cartId: path.cartId
      - text: Cancel assets {AssetIds} using cart {cartId}.
        slots:
          AssetIds: requestBody.AssetIds
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/asset/v1/assets/{cartId}/termination-date'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default asset termination date
      effect: read
      questions:
      - What termination date will be suggested by default when cancelling assets?
      - How is the default asset end date determined for a cart?
      instructions:
      - text: Get the default termination date for assets in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show the suggested asset end date for cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'