# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Consent API
  version: 1.0.0
extends: openapi/canopy-consent-api-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: 2
- target: $.paths['/consent'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a user's consent to the terms
      effect: write
      questions:
      - How do I record that a user agreed to the Canopy Connect privacy policy and terms?
      - What do I need to capture when logging a consumer's consent, like the device and the exact wording shown?
      - Can I store which terms version a person accepted along with their IP address?
      instructions:
      - text: Record consent from device {device} for terms version {version} with the wording {language}.
        slots:
          device: requestBody.device_identifier
          version: requestBody.terms_version
          language: requestBody.consent_language
      - text: Log that the user at IP {device} accepted terms {version}.
        slots:
          device: requestBody.device_identifier
          version: requestBody.terms_version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tos'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current terms of service
      effect: read
      questions:
      - Which terms of service version is current right now?
      - Where can I get the HTML of the terms to show a user before they consent?
      instructions:
      - text: Fetch the current terms of service version and its HTML.
      - text: Get the latest terms text I should display in my consent screen.
      method: generated
      generated: '2026-10-01'