# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Management API (mAPI) Partials API
  version: 1.0.0
extends: openapi/knock-app-partials-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/partials'].get
  update:
    x-apievangelist-phrasing:
      intent: List template partials
      effect: read
      questions:
      - Which reusable partials are available in this environment?
      - Can I list partials on a branch?
      instructions:
      - text: List partials in {environment}.
        slots:
          environment: query.environment
      - text: Show {limit} partials on branch {branch} in {environment}.
        slots:
          limit: query.limit
          branch: query.branch
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/partials/{partial_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template partial by key
      effect: read
      questions:
      - How do I see the content of one reusable partial?
      - Can I fetch a partial without uncommitted edits?
      instructions:
      - text: Get partial {partial_key} in {environment}.
        slots:
          partial_key: path.partial_key
          environment: query.environment
      - text: Show the {partial_key} partial.
        slots:
          partial_key: path.partial_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/partials/{partial_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a template partial
      effect: write
      questions:
      - How do I create a reusable template block for my notifications?
      - Can I commit a partial change as I save it?
      instructions:
      - text: Upsert partial {partial_key} in {environment} with {partial}.
        slots:
          partial_key: path.partial_key
          environment: query.environment
          partial: requestBody.partial
      - text: Save partial {partial_key} and commit with message {commit_message} in {environment}.
        slots:
          partial_key: path.partial_key
          commit_message: query.commit_message
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/partials/{partial_key}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate a partial without saving
      effect: read
      questions:
      - Can I check a partial for errors before saving it?
      - Is there a dry run for partial payloads?
      instructions:
      - text: Validate partial payload {partial} for {partial_key} in {environment}.
        slots:
          partial: requestBody.partial
          partial_key: path.partial_key
          environment: query.environment
      - text: Check partial {partial_key} definition {partial} without persisting it in {environment}.
        slots:
          partial_key: path.partial_key
          partial: requestBody.partial
          environment: query.environment
      method: generated
      generated: '2026-10-01'