Canopy Connect · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Teams API

4 actions 4 updates phrasing extends openapi/canopy-teams-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}'].get
$.paths['/teams/{teamId}'].delete
$.paths['/teams'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Teams API
  version: 1.0.0
extends: openapi/canopy-teams-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}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get team details
      effect: read
      questions:
      - How do I see information about my current team?
      - What details are stored for a team?
      instructions:
      - text: Get the details for team {team}.
        slots:
          team: path.teamId
      - text: Show me team {team}.
        slots:
          team: path.teamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deprovision a team
      effect: destructive
      questions:
      - How do I deprovision a team I no longer need?
      - Can I remove a team entirely?
      instructions:
      - text: Deprovision team {team}.
        slots:
          team: path.teamId
      - text: Delete team {team} permanently.
        slots:
          team: path.teamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new team
      effect: write
      questions:
      - How do I provision a new team for a company?
      - Can I set the company name when creating a team?
      instructions:
      - text: Provision a new team for {company}.
        slots:
          company: requestBody.company_name
      - text: Create a team named after the company {company}.
        slots:
          company: requestBody.company_name
      method: generated
      generated: '2026-10-01'