Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Groups API

8 actions 8 updates phrasing extends openapi/close-groups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/group/'].get
$.paths['/group/'].post
$.paths['/group/{group_id}/member/'].post
$.paths['/group/{group_id}/member/{user_id}/'].delete
$.paths['/group/{id}/'].get
$.paths['/group/{id}/'].put
$.paths['/group/{id}/'].delete

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 Close Groups API
  version: 1.0.0
extends: openapi/close-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/group/'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - What user groups exist in my organization?
      - Does the group list include each group's members?
      instructions:
      - text: List all groups in my organization.
      - text: Show every team group we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new team group?
      - Does a group name need to be unique?
      instructions:
      - text: Create a group named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new empty group called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{group_id}/member/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a group
      effect: write
      questions:
      - Can I add a teammate to an existing group?
      - What happens if the user is already in the group?
      instructions:
      - text: Add user {user_id} to group {group_id}.
        slots:
          user_id: requestBody.user_id
          group_id: path.group_id
      - text: Put {user_id} into group {group_id}.
        slots:
          user_id: requestBody.user_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{group_id}/member/{user_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a group
      effect: destructive
      questions:
      - Can I take someone out of a group without removing them from the organization?
      - Which call removes a single member from a group?
      instructions:
      - text: Remove user {user_id} from group {group_id}.
        slots:
          user_id: path.user_id
          group_id: path.group_id
      - text: Take {user_id} out of group {group_id}.
        slots:
          user_id: path.user_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a group and its members
      effect: read
      questions:
      - Who are the members of a particular group?
      - Can I retrieve one group's details by id?
      instructions:
      - text: Fetch group {id} with its members.
        slots:
          id: path.id
      - text: Show who belongs to group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a group
      effect: write
      questions:
      - Can I rename an existing group?
      - What happens if I rename a group to a name that's already taken?
      instructions:
      - text: Rename group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the name of group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/group/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - Can I delete a group that's used in a smart view or saved report?
      - Do members lose access to the organization when their group is deleted?
      instructions:
      - text: Delete group {id}.
        slots:
          id: path.id
      - text: Remove the group {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'