Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge Base Subpackage Articles API

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

$.info
$.paths['/knowledgebase/v1/articles'].get
$.paths['/knowledgebase/v1/articles/{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 Knowledge Base Subpackage Articles API
  version: 1.0.0
extends: openapi/merge-subpackage-articles-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: 2
- target: $.paths['/knowledgebase/v1/articles'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base articles
      effect: read
      questions:
      - Which articles are published in a connected knowledge base?
      - Can I list articles inside one container or under a parent article?
      instructions:
      - text: List articles with status {status}.
        slots:
          status: query.status
      - text: Show articles in container {parent_container_id}.
        slots:
          parent_container_id: query.parent_container_id
      - text: List child articles of {parent_article_id}.
        slots:
          parent_article_id: query.parent_article_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/articles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base article
      effect: read
      questions:
      - How do I fetch the content of one help-center article?
      - What author and status does a specific article have?
      instructions:
      - text: Get article {id}.
        slots:
          id: path.id
      - text: Fetch help article {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'