Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Groups API

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

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/groups'].get
$.paths['/groups/{id}'].get
$.paths['/filestorage/v1/groups'].get
$.paths['/filestorage/v1/groups/{id}'].get
$.paths['/hris/v1/groups'].get
$.paths['/hris/v1/groups/{id}'].get
$.paths['/hris/v1/groups/types'].get
$.paths['/knowledgebase/v1/groups'].get
$.paths['/knowledgebase/v1/groups/{id}'].get

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 Merge Subpackage Groups API
  version: 1.0.0
extends: openapi/merge-subpackage-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: 9
- target: $.paths['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat groups and channels
      effect: read
      questions:
      - How do I list the groups in my customer's chat workspace?
      - Can I only get chat groups modified since my last sync?
      instructions:
      - text: List chat groups modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show chat workspace groups for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one chat group
      effect: read
      questions:
      - Can I read a single chat group and its members?
      - What does one chat group record contain?
      instructions:
      - text: Get chat group {id}.
        slots:
          id: path.id
      - text: Fetch chat group {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List file storage permission groups
      effect: read
      questions:
      - Which user groups exist in the linked file storage platform?
      - Can I list file sharing groups created before a date?
      instructions:
      - text: List file storage groups created before {created_before}.
        slots:
          created_before: query.created_before
      - text: Find the file storage group with remote id {remote_id}.
        slots:
          remote_id: query.remote_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one file storage group
      effect: read
      questions:
      - How do I see who belongs to a single file storage group?
      - Can I get one drive-sharing group by id?
      instructions:
      - text: Get file storage group {id}.
        slots:
          id: path.id
      - text: Show the members of file storage group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List HRIS groups such as teams and departments
      effect: read
      questions:
      - How do I get departments, teams and cost centers from an HR system?
      - Can I return only HRIS groups that are commonly used as teams?
      - Which HR groups match a list of names or types?
      instructions:
      - text: List HRIS groups of types {types}.
        slots:
          types: query.types
      - text: Find HR groups named {names}.
        slots:
          names: query.names
      - text: Show only HRIS groups that act as teams.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HRIS group
      effect: read
      questions:
      - How can I read one department or team record from HR?
      - Can I see the parent group of a single HRIS group?
      instructions:
      - text: Get HRIS group {id}.
        slots:
          id: path.id
      - text: Fetch HR group {id} with related {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/groups/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List the distinct HRIS group types
      effect: read
      questions:
      - What kinds of groups (teams, departments, business units) does this HR system use?
      - Can I get the distinct group type values without listing every group, including deleted ones?
      instructions:
      - text: List the distinct HRIS group types in use.
      - text: Show HR group type values, counting groups deleted in the source system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base groups
      effect: read
      questions:
      - Which user groups are defined in the linked knowledge base?
      - Can I list knowledge base groups changed recently?
      instructions:
      - text: List knowledge base groups modified since {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show knowledge base groups created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one knowledge base group
      effect: read
      questions:
      - How do I read a single group from the knowledge base?
      - Can I expand related records on one knowledge base group?
      instructions:
      - text: Get knowledge base group {id}.
        slots:
          id: path.id
      - text: Fetch knowledge base group {id} and expand {relations}.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'