Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Generate Key API

9 actions 9 updates phrasing extends openapi/merge-subpackage-generatekey-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/generate-key'].post
$.paths['/ats/v1/generate-key'].post
$.paths['/generate-key'].post
$.paths['/crm/v1/generate-key'].post
$.paths['/filestorage/v1/generate-key'].post
$.paths['/hris/v1/generate-key'].post
$.paths['/knowledgebase/v1/generate-key'].post
$.paths['/ticketing/v1/generate-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 Generate Key API
  version: 1.0.0
extends: openapi/merge-subpackage-generatekey-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/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (accounting path)
      effect: write
      questions:
      - How do I generate a new production API key from the accounting endpoint?
      - Does a new remote key need a name?
      instructions:
      - text: Generate an accounting-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Create API key {name} via the accounting generate-key call.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (ATS path)
      effect: write
      questions:
      - Can I mint a new remote key through the ATS category endpoint?
      - What do I send to create a named key from the recruiting API?
      instructions:
      - text: Generate a remote key called {name} using the ATS path.
        slots:
          name: requestBody.name
      - text: Make a new recruiting-endpoint API key labeled {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (root path)
      effect: write
      questions:
      - Is there a generate-key endpoint at the root path with no category?
      - Can I create a remote key without going through a category-specific URL?
      instructions:
      - text: Call the root /generate-key route to create key {name}.
        slots:
          name: requestBody.name
      - text: Use the category-less path to generate remote key {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (CRM path)
      effect: write
      questions:
      - Can I generate a new remote key from the CRM API?
      - What's required to create a key through the CRM generate-key call?
      instructions:
      - text: Generate a CRM-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Create key {name} with the CRM generate-key endpoint.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (file storage path)
      effect: write
      questions:
      - Can I create a remote key from the file storage category endpoint?
      - Which field names a key generated via file storage?
      instructions:
      - text: Generate a file storage-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Mint drive-endpoint API key {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (HRIS path)
      effect: write
      questions:
      - Can I generate a new remote key through the HRIS endpoint?
      - What input does the HR generate-key call take?
      instructions:
      - text: Generate an HRIS-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Create HR-endpoint API key {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (knowledge base path)
      effect: write
      questions:
      - Can I create a remote key via the knowledge base category?
      - Does the wiki generate-key endpoint only need a key name?
      instructions:
      - text: Generate a knowledge base-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Mint wiki-endpoint API key {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/generate-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote API key (ticketing path)
      effect: write
      questions:
      - Can I generate a new remote key from the ticketing API?
      - What does the helpdesk generate-key call require?
      instructions:
      - text: Generate a ticketing-path remote key named {name}.
        slots:
          name: requestBody.name
      - text: Create helpdesk-endpoint API key {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'