docs: document datasource_info_list schemas and improve Run Pipeline API#741
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
dosubot
Bot
added
the
size:XL
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the “Run Pipeline” API documentation by adding typed schemas and concrete examples for datasource_info_list, expanding parameter descriptions, and syncing those updates across English, Japanese, and Chinese OpenAPI specs.
Changes:
- Replace
datasource_info_listitem schema with typedoneOfvariants for eachdatasource_type - Add request examples for each datasource type (local file / online document / website crawl / online drive)
- Expand descriptions for inputs and the streaming (SSE) response event structure; sync zh/ja with en
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| en/api-reference/openapi_knowledge.json | Adds typed oneOf item schemas + request examples + richer SSE description for Run Pipeline |
| ja/api-reference/openapi_knowledge.json | Mirrors the English schema/example/description updates in Japanese |
| zh/api-reference/openapi_knowledge.json | Mirrors the English schema/example updates and refines some parameter descriptions in Chinese |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
oneOfitem schemas fordatasource_info_list, documenting the required fields perdatasource_type:local_file,online_document,website_crawl,online_driveinputs,start_node_id,is_published,credential_id, and the SSE streaming response event structurereferencefield to say "use theidreturned by Upload Pipeline File"Closes #739