Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agent Handler Subpackage Application Credentials API

6 actions 6 updates phrasing extends openapi/merge-subpackage-applicationcredentials-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/application-credentials/'].get

$.paths['/api/v1/application-credentials/'].post

$.paths['/api/v1/application-credentials/{id}/'].get

$.paths['/api/v1/application-credentials/{id}/'].delete

$.paths['/api/v1/application-credentials/{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 Application Credentials API
  version: 1.0.0
extends: openapi/merge-subpackage-applicationcredentials-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/application-credentials/'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth application credentials
      effect: read
      questions:
      - Which OAuth apps has my organization registered for Agent Handler connectors?
      - Can I filter application credentials by connector slug or external id?
      instructions:
      - text: List OAuth application credentials for connector {slug}.
        slots:
          slug: query.slug
      - text: Find the application credential with external id {external_id}.
        slots:
          external_id: query.external_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/application-credentials/'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth app for a connector
      effect: write
      questions:
      - How do I bring my own OAuth client ID and secret for a connector?
      - When do I need an external_id on an application credential?
      instructions:
      - text: Create an OAuth application credential for connector {connector_slug} with client id {client_id}.
        slots:
          connector_slug: requestBody.connector_slug
          client_id: requestBody.client_id
      - text: Register OAuth app {client_id} with secret {client_secret} on {connector_slug} for tenant {external_id}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          connector_slug: requestBody.connector_slug
          external_id: requestBody.external_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/application-credentials/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one OAuth application credential
      effect: read
      questions:
      - Can I look up a single OAuth app credential by its id?
      - What does a stored application credential show?
      instructions:
      - text: Get application credential {id}.
        slots:
          id: path.id
      - text: Show the OAuth app configuration for credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/application-credentials/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth application credential
      effect: destructive
      questions:
      - What happens to user credentials when I delete an OAuth application credential?
      - Can I remove an OAuth app I no longer use for a connector?
      instructions:
      - text: Delete application credential {id}.
        slots:
          id: path.id
      - text: Remove OAuth app credential {id} and its associated user credentials.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/application-credentials/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth application credential
      effect: write
      questions:
      - Can I rotate the client secret on an existing OAuth app credential?
      - How do I clear the external_id on an application credential?
      instructions:
      - text: Set the client secret on application credential {id} to {client_secret}.
        slots:
          id: path.id
          client_secret: requestBody.client_secret
      - text: Change credential {id} to use client id {client_id}.
        slots:
          id: path.id
          client_id: requestBody.client_id
      method: generated
      generated: '2026-09-26'