Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Teams API

8 actions 8 updates phrasing extends openapi/act-teams-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/teams/{teamNameOrId}/roster'].get

$.paths['/api/teams/{id}'].get

$.paths['/api/teams/{id}'].put

$.paths['/api/teams/{id}'].delete

$.paths['/api/teams/{id}'].patch

$.paths['/api/teams'].get

$.paths['/api/teams'].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 act.web.api Teams API
  version: 1.0.0
extends: openapi/act-teams-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: 7
- target: $.paths['/api/teams/{teamNameOrId}/roster'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team's roster
      effect: read
      questions:
      - Who is on a particular team?
      - Can I look up a team roster by the team's name instead of its id?
      instructions:
      - text: Show the roster of team {teamNameOrId}.
        slots:
          teamNameOrId: path.teamNameOrId
      - text: List the members of the {teamNameOrId} team.
        slots:
          teamNameOrId: path.teamNameOrId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team
      effect: read
      questions:
      - How do I look up one team by its id?
      - What does a team record include besides its roster?
      instructions:
      - text: Fetch team {id}.
        slots:
          id: path.id
      - text: Show the description of team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a team
      effect: write
      questions:
      - How do I overwrite a team's description and full roster?
      - Can I resend the entire team to replace its members?
      instructions:
      - text: Replace team {id} with roster {roster}.
        slots:
          id: path.id
          roster: requestBody.roster
      - text: Fully update team {id} with description {description} and roster {roster}.
        slots:
          id: path.id
          description: requestBody.description
          roster: requestBody.roster
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team
      effect: destructive
      questions:
      - How do I delete a team I no longer need?
      - Does deleting a team remove its users from the system?
      instructions:
      - text: Delete team {id}.
        slots:
          id: path.id
      - text: Remove team {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change part of a team
      effect: write
      questions:
      - Can I update only a team's description?
      - How do I change a team's roster without resending everything?
      instructions:
      - text: Change the description of team {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Patch team {id} so its roster is {roster}.
        slots:
          id: path.id
          roster: requestBody.roster
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List all teams
      effect: read
      questions:
      - What teams exist in my database?
      - Which teams have been set up for users?
      instructions:
      - text: List all teams.
      - text: Show every team we have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team
      effect: write
      questions:
      - How do I create a new team of users?
      - Can I set the roster when creating a team?
      instructions:
      - text: Create a team described as {description} with roster {roster}.
        slots:
          description: requestBody.description
          roster: requestBody.roster
      - text: Set up a new team {description}.
        slots:
          description: requestBody.description
      method: generated
      generated: '2026-10-01'