fix: bulk user operation markdown files missing examples#1529
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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
getMethodMarkdownContentfunction - No content files, sidebar navigation, OpenAPI specs, package dependencies, or build configuration files are modified
- The bug fix (checking
requestBodyContent?.examplein addition torequestBody.examplefor 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
Sent by Cursor Automation: Docs PR classifier
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


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/*, etcCurrent: 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