Skip to content

fix: bulk user operation markdown files missing examples#1529

Merged
MikeCarbone merged 2 commits into
mainfrom
mc-fix-bulk-markdown-files
Jul 9, 2026
Merged

fix: bulk user operation markdown files missing examples#1529
MikeCarbone merged 2 commits into
mainfrom
mc-fix-bulk-markdown-files

Conversation

@MikeCarbone

@MikeCarbone MikeCarbone commented Jul 9, 2026

Copy link
Copy Markdown
Member

Description

Markdown files for user bulk operations were missing examples. This fixes it for all subresource endpoints like users/bulk/*, objects/bulk/*, tenants/bulk/*, schedules/bulk/*, channels/bulk/*, users/feeds/*, users/guides/*, messages/batch/*, integrations/*, providers/*, etc

Current: https://docs.knock.app/api-reference/users/bulk/identify.md

Fixed: https://docs-git-mc-fix-bulk-markdown-files-knocklabs.vercel.app/api-reference/users/bulk/identify.md

@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 9, 2026 6:10pm

Request Review

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk LOW: Refactors and fixes the generateApiMarkdown.ts build script to deduplicate method markdown generation and correctly extract examples from OpenAPI spec media type level.

Reasons

  • Only 1 file changed (scripts/generateApiMarkdown.ts), which is outside the high-risk directories (components/, layouts/, lib/, styles/)
  • Net-negative diff (17 additions, 73 deletions) — primarily removes duplicated inline logic in favor of calling the existing getMethodMarkdownContent function
  • No content files, sidebar navigation, OpenAPI specs, package dependencies, or build configuration files are modified
  • The bug fix (checking requestBodyContent?.example in addition to requestBody.example for both request and response examples) is narrowly scoped and follows existing patterns in the same function
  • Author (MikeCarbone) is a known team member

Notes

  • Verify that generated markdown files for bulk operation endpoints (e.g. users/bulk/*, objects/bulk/*) now include the expected examples after running the generation script
  • Confirm the example extraction precedence (mediaTypeContent?.example || schema.example) matches the intended OpenAPI spec structure for these endpoints
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

@MikeCarbone MikeCarbone merged commit 7b8b661 into main Jul 9, 2026
5 checks passed
@MikeCarbone MikeCarbone deleted the mc-fix-bulk-markdown-files branch July 9, 2026 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant