Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Regenerate Key API

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

$.info
$.paths['/accounting/v1/regenerate-key'].post
$.paths['/ats/v1/regenerate-key'].post
$.paths['/regenerate-key'].post
$.paths['/crm/v1/regenerate-key'].post
$.paths['/filestorage/v1/regenerate-key'].post
$.paths['/hris/v1/regenerate-key'].post
$.paths['/knowledgebase/v1/regenerate-key'].post
$.paths['/ticketing/v1/regenerate-key'].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 Merge Subpackage Regenerate Key API
  version: 1.0.0
extends: openapi/merge-subpackage-regeneratekey-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: 8
- target: $.paths['/accounting/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (accounting path)
      effect: destructive
      questions:
      - How do I rotate my remote API key through the accounting endpoint?
      - Can I exchange my current remote key for a fresh one via the accounting path?
      instructions:
      - text: Regenerate the remote key via the accounting path and name the new one {name}.
        slots:
          name: requestBody.name
      - text: Rotate keys through accounting, labeling the replacement {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (ATS path)
      effect: destructive
      questions:
      - Can I rotate my remote key using the ATS endpoint?
      - What name should the replacement key get when exchanging via recruiting?
      instructions:
      - text: Regenerate the remote key via the ATS path as {name}.
        slots:
          name: requestBody.name
      - text: Swap my key for a new one named {name} through the recruiting API.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (root path)
      effect: destructive
      questions:
      - Is there a regenerate-key endpoint at the root path without a category?
      - Can I exchange remote keys without a category-specific URL?
      instructions:
      - text: Call the root /regenerate-key route and name the new key {name}.
        slots:
          name: requestBody.name
      - text: Use the category-less path to exchange keys for one called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (CRM path)
      effect: destructive
      questions:
      - Can I rotate my remote key from the CRM API?
      - What does the CRM regenerate-key call need?
      instructions:
      - text: Regenerate the remote key via the CRM path as {name}.
        slots:
          name: requestBody.name
      - text: Exchange keys with the CRM endpoint, naming the new one {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (file storage path)
      effect: destructive
      questions:
      - Can I rotate my remote key through the file storage endpoint?
      - Which field names the replacement key when exchanging via file storage?
      instructions:
      - text: Regenerate the remote key via the file storage path as {name}.
        slots:
          name: requestBody.name
      - text: Rotate keys using the drive endpoint, new key named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (HRIS path)
      effect: destructive
      questions:
      - Can I rotate my remote key using the HRIS API?
      - What input does the HR regenerate-key call accept?
      instructions:
      - text: Regenerate the remote key via the HRIS path as {name}.
        slots:
          name: requestBody.name
      - text: Exchange keys through the HR endpoint, calling the new one {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (knowledge base path)
      effect: destructive
      questions:
      - Can I rotate my remote key via the knowledge base category?
      - Does the wiki regenerate-key call only take a name?
      instructions:
      - text: Regenerate the remote key via the knowledge base path as {name}.
        slots:
          name: requestBody.name
      - text: Rotate keys using the wiki endpoint, new key named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/regenerate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange remote keys (ticketing path)
      effect: destructive
      questions:
      - Can I rotate my remote key from the ticketing API?
      - What does the helpdesk regenerate-key call require?
      instructions:
      - text: Regenerate the remote key via the ticketing path as {name}.
        slots:
          name: requestBody.name
      - text: Exchange keys through the helpdesk endpoint, naming the new one {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'