Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agent Handler Subpackage Registered Users API

6 actions 6 updates phrasing extends openapi/merge-subpackage-registeredusers-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 6

$.info

$.paths['/api/v1/registered-users/'].get

$.paths['/api/v1/registered-users/'].post

$.paths['/api/v1/registered-users/{registered_user_id}/'].get

$.paths['/api/v1/registered-users/{registered_user_id}/'].delete

$.paths['/api/v1/registered-users/{registered_user_id}/'].patch

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 Agent Handler Subpackage Registered Users API
  version: 1.0.0
extends: openapi/merge-subpackage-registeredusers-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: 5
- target: $.paths['/api/v1/registered-users/'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered users
      effect: read
      questions:
      - Which registered users exist in my organization?
      - Can I find a registered user by their origin user ID?
      instructions:
      - text: List registered users with origin user ID {origin_user_id}.
        slots:
          origin_user_id: query.origin_user_id
      - text: Show all my registered users.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registered-users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a user
      effect: write
      questions:
      - How do I register one of my app's users?
      - Can I register a system user instead of a human?
      instructions:
      - text: Register user {origin_user_name} with origin ID {origin_user_id} and id {id}.
        slots:
          origin_user_name: requestBody.origin_user_name
          origin_user_id: requestBody.origin_user_id
          id: requestBody.id
      - text: Create a {user_type} registered user {origin_user_name} (origin {origin_user_id}, id {id}).
        slots:
          user_type: requestBody.user_type
          origin_user_name: requestBody.origin_user_name
          origin_user_id: requestBody.origin_user_id
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registered-users/{registered_user_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered user
      effect: read
      questions:
      - How do I look up one registered user?
      - What user type and credential group does a registered user have?
      instructions:
      - text: Get registered user {registered_user_id}.
        slots:
          registered_user_id: path.registered_user_id
      - text: Show details for registered user {registered_user_id}.
        slots:
          registered_user_id: path.registered_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registered-users/{registered_user_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registered user
      effect: destructive
      questions:
      - What removes a registered user from my organization?
      - Can I permanently delete a registered user record?
      instructions:
      - text: Delete registered user {registered_user_id}.
        slots:
          registered_user_id: path.registered_user_id
      - text: Remove registered user {registered_user_id} for good.
        slots:
          registered_user_id: path.registered_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registered-users/{registered_user_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a registered user
      effect: write
      questions:
      - How do I rename a registered user?
      - Can I move a registered user to a different shared credential group?
      instructions:
      - text: Rename registered user {registered_user_id} to {origin_user_name}.
        slots:
          registered_user_id: path.registered_user_id
          origin_user_name: requestBody.origin_user_name
      - text: Put registered user {registered_user_id} in credential group {shared_credential_group}.
        slots:
          registered_user_id: path.registered_user_id
          shared_credential_group: requestBody.shared_credential_group
      method: generated
      generated: '2026-09-26'