Canopy Connect · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Servicings API

4 actions 4 updates phrasing extends openapi/canopy-servicings-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 4

$.info

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

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

$.paths['/teams/{teamId}/servicings/{servicingActionId}'].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 Servicings API
  version: 1.0.0
extends: openapi/canopy-servicings-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: 3
- target: $.paths['/teams/{teamId}/servicings'].get
  update:
    x-apievangelist-phrasing:
      intent: List servicing actions
      effect: read
      questions:
      - Which servicing actions has my team requested on insurance accounts?
      - Can I list only the servicing actions for one pull?
      instructions:
      - text: List servicing actions on team {team}.
        slots:
          team: path.teamId
      - text: Show servicing actions for pull {pull} on team {team}.
        slots:
          pull: query.pull_id
          team: path.teamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/servicings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create servicing actions on an existing pull
      effect: write
      questions:
      - How do I request changes to a policy reusing the login and consent from an earlier pull?
      - Can I create servicing actions without collecting the consumer's credentials again?
      instructions:
      - text: Create servicing actions {actions} on team {team} using pull {pull}.
        slots:
          actions: requestBody.servicing_actions
          team: path.teamId
          pull: requestBody.pull_id
      - text: Reuse pull {pull}'s credentials to submit servicing actions {actions}.
        slots:
          pull: requestBody.pull_id
          actions: requestBody.servicing_actions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/servicings/{servicingActionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a servicing action
      effect: read
      questions:
      - How do I check the status of one servicing action?
      - What details does a single servicing action show?
      instructions:
      - text: Get servicing action {action} on team {team}.
        slots:
          action: path.servicingActionId
          team: path.teamId
      - text: Show me servicing action {action}.
        slots:
          action: path.servicingActionId
      method: generated
      generated: '2026-10-01'