# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect Marketplace Webhooks API
  version: 1.0.0
extends: openapi/ios-marketplacewebhooks-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: 4
- target: $.paths['/v1/marketplaceWebhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketplace webhooks
      effect: read
      questions:
      - Which alternative marketplace webhooks have I registered?
      - Can I see the endpoint URLs of my marketplace webhooks?
      instructions:
      - text: List my marketplace webhooks.
      - text: Show up to {limit} marketplace webhooks.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/marketplaceWebhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a marketplace webhook
      effect: write
      questions:
      - How do I get notified when my alternative marketplace receives events?
      - Can I register a webhook URL with a secret for my marketplace?
      instructions:
      - text: Create a marketplace webhook with {details}.
        slots:
          details: requestBody.data
      - text: 'Register a new marketplace webhook endpoint: {details}.'
        slots:
          details: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/marketplaceWebhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a marketplace webhook
      effect: destructive
      questions:
      - How do I stop receiving marketplace webhook events?
      - Can I remove a marketplace webhook I registered?
      instructions:
      - text: Delete marketplace webhook {id}.
        slots:
          id: path.id
      - text: Unregister marketplace webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/marketplaceWebhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a marketplace webhook
      effect: write
      questions:
      - Can I change the URL or secret of an existing marketplace webhook?
      - How do I rotate a marketplace webhook's secret?
      instructions:
      - text: Update marketplace webhook {id} with {details}.
        slots:
          id: path.id
          details: requestBody.data
      - text: Change the endpoint of marketplace webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'