Canopy Connect · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Policy Check Team Setting API

3 actions 3 updates phrasing extends openapi/canopy-policy-check-team-setting-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['/teams/{teamId}/policyChecks/settings'].get
$.paths['/teams/{teamId}/policyChecks/settings'].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 Policy Check Team Setting API
  version: 1.0.0
extends: openapi/canopy-policy-check-team-setting-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['/teams/{teamId}/policyChecks/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View the team's Policy Check settings
      effect: read
      questions:
      - Which Policy Checks are configured on my account?
      - How can I see what checks run on every submission?
      instructions:
      - text: Show the Policy Check settings for team {team}.
        slots:
          team: path.teamId
      - text: List the Policy Checks currently configured on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/policyChecks/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure the team's Policy Checks
      effect: write
      questions:
      - How do I change which Policy Checks run on every submission?
      - Can I turn on new Policy Checks for my whole team?
      instructions:
      - text: Update the Policy Check settings for team {team} to {settings}.
        slots:
          team: path.teamId
          settings: requestBody.policy_check_settings
      - text: 'Configure team {team} to run these Policy Checks on every submission: {settings}.'
        slots:
          team: path.teamId
          settings: requestBody.policy_check_settings
      method: generated
      generated: '2026-10-01'