Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Users Feeds API

3 actions 3 updates phrasing extends openapi/knock-app-feeds-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Knock's API. It is a proposal applied on top of the contract, not a document Knock publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/users/{user_id}/feeds/{id}'].get

$.paths['/v1/users/{user_id}/feeds/{id}/settings'].get

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 Knock Users Feeds API
  version: 1.0.0
extends: openapi/knock-app-feeds-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: 2
- target: $.paths['/v1/users/{user_id}/feeds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's in-app feed items
      effect: read
      questions:
      - How do I load a user's in-app notification feed?
      - Can I show only unread or archived feed items?
      - What does the feed return for a user Knock hasn't identified yet?
      instructions:
      - text: List feed items for user {user_id} in feed {id}.
        slots:
          user_id: path.user_id
          id: path.id
      - text: Show user {user_id}'s {status} items in feed {id}.
        slots:
          user_id: path.user_id
          status: query.status
          id: path.id
      - text: Load only tenant {tenant} notifications from feed {id} for {user_id}.
        slots:
          id: path.id
          user_id: path.user_id
          tenant: query.tenant
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/{user_id}/feeds/{id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's feed settings
      effect: read
      questions:
      - What feed settings apply to a user's in-app feed?
      - Can I check a feed's configuration for one user?
      instructions:
      - text: Get feed {id} settings for user {user_id}.
        slots:
          id: path.id
          user_id: path.user_id
      - text: Show user {user_id}'s settings for feed {id}.
        slots:
          user_id: path.user_id
          id: path.id
      method: generated
      generated: '2026-10-01'