# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Website Carriers API
  version: 1.0.0
extends: openapi/optimizely-website-carriers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/WebsiteCarriers'].get
  update:
    x-apievangelist-phrasing:
      intent: List carriers enabled on websites
      effect: read
      questions:
      - Which shipping carriers are enabled on each website?
      - How do I list all website-carrier assignments?
      instructions:
      - text: List all website carrier assignments.
      - text: Show which carriers each storefront offers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a carrier on a website
      effect: write
      questions:
      - How do I offer a shipping carrier on a specific website?
      - Can I assign a carrier to a storefront through the admin API?
      instructions:
      - text: Enable carrier {carrierId} on website {websiteId}.
        slots:
          carrierId: requestBody.carrierId
          websiteId: requestBody.websiteId
      - text: Assign shipping carrier {carrierId} to storefront {websiteId}.
        slots:
          carrierId: requestBody.carrierId
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website carrier assignment
      effect: read
      questions:
      - Is there a call to read one website-carrier assignment by ID?
      - Which website and carrier does a given assignment link?
      instructions:
      - text: Get website carrier assignment {id}.
        slots:
          id: path.id
      - text: Show the website and carrier on assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website carrier assignment
      effect: write
      questions:
      - What's the call to overwrite a website-carrier assignment entirely?
      - Can I fully replace which site and carrier an assignment covers?
      instructions:
      - text: Replace assignment {id} with website {websiteId} and carrier {carrierId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          carrierId: requestBody.carrierId
      - text: Overwrite website carrier record {id} in full with carrier {carrierId}.
        slots:
          id: path.id
          carrierId: requestBody.carrierId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a carrier from a website
      effect: destructive
      questions:
      - How do I stop offering a carrier on a website?
      - Can I delete a website carrier assignment with an ETag check?
      instructions:
      - text: Delete website carrier assignment {id}.
        slots:
          id: path.id
      - text: Delete carrier assignment {id} if ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a website carrier assignment
      effect: write
      questions:
      - How do I swap the carrier on an existing website assignment?
      - Can I move a carrier assignment to another website?
      instructions:
      - text: Switch assignment {id} to carrier {carrierId}.
        slots:
          id: path.id
          carrierId: requestBody.carrierId
      - text: Move carrier assignment {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCarriers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default website carrier template
      effect: read
      questions:
      - What does a blank website carrier assignment look like?
      - Where do I get default values for a new carrier assignment?
      instructions:
      - text: Get the default website carrier template.
      - text: Show default fields for a new website carrier link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecarriers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete website carrier assignments
      effect: destructive
      questions:
      - Can I remove many carrier assignments at once?
      - Can I bulk delete website carriers by ID?
      instructions:
      - text: Bulk delete website carrier assignments {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these carrier assignments: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecarriers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a website carrier
      effect: read
      questions:
      - Where would I read a custom property on a website carrier assignment?
      - Can I fetch an extra attribute stored on a website carrier link?
      instructions:
      - text: Get custom property {prop} on website carrier {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      - text: Show custom field {prop} for website carrier {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      method: generated
      generated: '2026-09-26'