Canopy Connect · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Policy Forms API

3 actions 3 updates phrasing extends openapi/canopy-policy-forms-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 3

$.info

$.paths['/policyforms/{policyFormId}/pdf'].get

$.paths['/teams/{teamId}/policyForms/{policyFormId}'].get

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 Forms API
  version: 1.0.0
extends: openapi/canopy-policy-forms-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['/policyforms/{policyFormId}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a policy form PDF (deprecated)
      effect: read
      questions:
      - Is there an older endpoint that streams a policy form PDF directly by form ID alone?
      - Why is the policy form PDF route without a team deprecated?
      instructions:
      - text: Download policy form {form} as a PDF using the deprecated streaming endpoint.
        slots:
          form: path.policyFormId
      - text: Stream the PDF for policy form {form} through the legacy route.
        slots:
          form: path.policyFormId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/policyForms/{policyFormId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a policy form via signed URL
      effect: read
      questions:
      - How do I download a policy form for my team as a short-lived signed link?
      - Does downloading a policy form in production require a plan with policy forms?
      instructions:
      - text: Get the signed download link for policy form {form} on team {team}.
        slots:
          form: path.policyFormId
          team: path.teamId
      - text: Download policy form {form} for team {team}.
        slots:
          form: path.policyFormId
          team: path.teamId
      method: generated
      generated: '2026-10-01'