Canopy Connect · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Policy Search API

2 actions 2 updates phrasing extends openapi/canopy-policy-search-api-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Canopy Connect's API. It is a proposal applied on top of the contract, not a document Canopy Connect publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/teams/{teamId}/policySearch'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Policy Search API
  version: 1.0.0
extends: openapi/canopy-policy-search-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: 1
- target: $.paths['/teams/{teamId}/policySearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for a policy without credentials
      effect: write
      questions:
      - Can I find someone's auto or home insurance policy without their carrier login?
      - How do I run an Auto ID Card search with a carrier?
      - What consent details must I send before starting a credential-less policy search?
      instructions:
      - text: Start a {type} policy search at carrier {carrier} on team {team} with {data}, widget {alias}, consent from {device} on terms {version} with wording {language}.
        slots:
          type: requestBody.searchType
          carrier: requestBody.insurerName
          team: path.teamId
          data: requestBody.searchData
          alias: requestBody.public_alias
          device: requestBody.device_identifier
          version: requestBody.terms_version
          language: requestBody.consent_language
      - text: Search carrier {carrier} for an Auto ID Card using {data}.
        slots:
          carrier: requestBody.insurerName
          data: requestBody.searchData
      method: generated
      generated: '2026-10-01'