Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock App Schedules API

7 actions 7 updates phrasing extends openapi/knock-app-schedules-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 7

$.info

$.paths['/v1/objects/{collection}/{id}/schedules'].get

$.paths['/v1/schedules'].get

$.paths['/v1/schedules'].put

$.paths['/v1/schedules'].post

$.paths['/v1/schedules'].delete

$.paths['/v1/users/{user_id}/schedules'].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 App Schedules API
  version: 1.0.0
extends: openapi/knock-app-schedules-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: 6
- target: $.paths['/v1/objects/{collection}/{id}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's schedules
      effect: read
      questions:
      - Which recurring notifications are scheduled for an object?
      - Can I filter an object's schedules by workflow?
      instructions:
      - text: List schedules for object {id} in {collection}.
        slots:
          id: path.id
          collection: path.collection
      - text: Show {collection}/{id} schedules for workflow {workflow}.
        slots:
          collection: path.collection
          id: path.id
          workflow: query.workflow
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List schedules for a workflow
      effect: read
      questions:
      - Which schedules exist for a given workflow?
      - Can I narrow a workflow's schedules to certain recipients or a tenant?
      instructions:
      - text: List schedules for workflow {workflow}.
        slots:
          workflow: query.workflow
      - text: Show workflow {workflow} schedules for recipients {recipients}.
        slots:
          workflow: query.workflow
          recipients: query.recipients[]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/schedules'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing schedules
      effect: write
      questions:
      - How do I change the timing of schedules I already created?
      - Can I apply the same new data to several schedules at once?
      instructions:
      - text: Update schedules {schedule_ids} to run at {scheduled_at}.
        slots:
          schedule_ids: requestBody.schedule_ids
          scheduled_at: requestBody.scheduled_at
      - text: Change the repeat rules on schedules {schedule_ids} to {repeats}.
        slots:
          schedule_ids: requestBody.schedule_ids
          repeats: requestBody.repeats
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a workflow for recipients
      effect: write
      questions:
      - How do I schedule a recurring digest for a set of users?
      - Can I create a one-time scheduled notification at a specific time?
      instructions:
      - text: Schedule workflow {workflow} for {recipients} repeating {repeats}.
        slots:
          workflow: requestBody.workflow
          recipients: requestBody.recipients
          repeats: requestBody.repeats
      - text: Create a one-time schedule of {workflow} for {recipients} at {scheduled_at}.
        slots:
          workflow: requestBody.workflow
          recipients: requestBody.recipients
          scheduled_at: requestBody.scheduled_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/schedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete schedules
      effect: destructive
      questions:
      - How do I stop and remove schedules permanently?
      - Can deleted schedules be restored?
      instructions:
      - text: Delete schedules {schedule_ids}.
        slots:
          schedule_ids: requestBody.schedule_ids
      - text: 'Permanently remove these schedules: {schedule_ids}.'
        slots:
          schedule_ids: requestBody.schedule_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/{user_id}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's schedules
      effect: read
      questions:
      - What scheduled notifications does a particular user have?
      - Can I filter a user's schedules by tenant?
      instructions:
      - text: List schedules for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show user {user_id}'s schedules for workflow {workflow}.
        slots:
          user_id: path.user_id
          workflow: query.workflow
      method: generated
      generated: '2026-10-01'