# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Storefronts API
  version: 1.0.0
extends: openapi/conga-storefronts-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: 8
- target: $.paths['/storefronts'].get
  update:
    x-apievangelist-phrasing:
      intent: List storefronts
      effect: read
      questions:
      - What storefronts are set up in my Conga commerce admin?
      - Can I filter and sort the storefront list and page through it?
      instructions:
      - text: List all storefront records.
      - text: List storefronts matching {filter}, sorted by {sort}, {limit} per page.
        slots:
          filter: query.filter
          sort: query.sort
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one or more storefronts
      effect: write
      questions:
      - How do I add a new storefront?
      - Can I create several storefronts in a single request?
      instructions:
      - text: Create new storefronts from the details I provide.
      - text: Set up a batch of new storefront records in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several storefronts at once
      effect: destructive
      questions:
      - Can I remove a whole list of storefronts by their IDs in one go?
      - Is there a bulk way to clean up old storefronts?
      instructions:
      - text: Bulk delete the storefronts whose IDs I list.
      - text: Remove this set of storefront records in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several storefronts at once
      effect: write
      questions:
      - Can I change settings on many storefronts with one request?
      - What's the bulk way to edit multiple storefront records together?
      instructions:
      - text: Bulk update the storefronts in my list with these new details.
      - text: Apply these changes across multiple storefront records at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active storefront
      effect: read
      questions:
      - Which storefront is currently active for my session?
      - Can I fetch just the active storefront and only certain fields from it?
      instructions:
      - text: Get the currently active storefront.
      - text: Fetch the active storefront for storefront ID {storeFrontId}.
        slots:
          storeFrontId: header.storeFrontId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single storefront
      effect: read
      questions:
      - How can I see the full details of one specific storefront?
      - Can I pull a storefront along with its related entities?
      instructions:
      - text: Get storefront {Id}.
        slots:
          Id: path.Id
      - text: Retrieve storefront {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one storefront
      effect: destructive
      questions:
      - Can I delete a single storefront I no longer use?
      - What happens when I remove one storefront by its ID?
      instructions:
      - text: Delete storefront {Id}.
        slots:
          Id: path.Id
      - text: Remove the storefront record with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/storefronts/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one storefront
      effect: write
      questions:
      - Can I edit the details of just one storefront?
      - Which call changes a single storefront without touching the others?
      instructions:
      - text: Update storefront {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit the details of the storefront with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'