run-llama/workflows-py
1
0
Fork 0
mirror of https://github.com/run-llama/workflows-py.git synced 2026-08-24 20:01:34 -04:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

[PR #160] Generate workflow server reference docs #176

New Issue
Open
opened 2026-02-16 02:16:49 -05:00 by yindo · 0 comments
yindo commented 2026-02-16 02:16:49 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/run-llama/workflows-py/pull/160
Author: @adrianlyjak
Created: 10/24/2025
Status: 🔄 Open

Base: main ← Head: cursor/LI-3952-generate-workflow-server-reference-docs-0107

📝 Commits (5)

  • 88a7596 Add script to generate Workflows Server API reference docs from OpenAPI
  • a8ef947 Add Workflows API reference documentation
  • 25d8de5 Fix basedpyright typing issues in docs generator
  • d7c2882 Ensure generated markdown ends with newline; regenerate server API reference
  • cfcc1cf Render OpenAPI schemas in readable tables and resolve $refs

📊 Changes

3 files changed (+1487 additions, -0 deletions)

View changed files

➕ docs/src/content/docs/workflows-api-reference/index.md (+1017 -0)
📝 pyproject.toml (+2 -0)
➕ scripts/generate_server_reference_docs.py (+468 -0)

📄 Description

Add a script to generate Markdown reference docs for the workflows server API from its OpenAPI schema.

Linear Issue: LI-3952

Open in Cursor Open in Web

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/run-llama/workflows-py/pull/160 **Author:** [@adrianlyjak](https://github.com/adrianlyjak) **Created:** 10/24/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `cursor/LI-3952-generate-workflow-server-reference-docs-0107` --- ### 📝 Commits (5) - [`88a7596`](https://github.com/run-llama/workflows-py/commit/88a75960a4bfaf92c184021c15cc7f7fab4eeec9) Add script to generate Workflows Server API reference docs from OpenAPI - [`a8ef947`](https://github.com/run-llama/workflows-py/commit/a8ef947f9be49bea3844a98b0fdcd431af217643) Add Workflows API reference documentation - [`25d8de5`](https://github.com/run-llama/workflows-py/commit/25d8de58c2a1de838265bc45080e347fdbd2ecc1) Fix basedpyright typing issues in docs generator - [`d7c2882`](https://github.com/run-llama/workflows-py/commit/d7c288273239eb8eb9e526562d5f9130dfc9c043) Ensure generated markdown ends with newline; regenerate server API reference - [`cfcc1cf`](https://github.com/run-llama/workflows-py/commit/cfcc1cf8e3966e06a69bd5a6853c1e09acbbfed7) Render OpenAPI schemas in readable tables and resolve $refs ### 📊 Changes **3 files changed** (+1487 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/src/content/docs/workflows-api-reference/index.md` (+1017 -0) 📝 `pyproject.toml` (+2 -0) ➕ `scripts/generate_server_reference_docs.py` (+468 -0) </details> ### 📄 Description Add a script to generate Markdown reference docs for the workflows server API from its OpenAPI schema. --- Linear Issue: [LI-3952](https://linear.app/llamaindex/issue/LI-3952/add-reference-docs-for-workflows-server) <a href="https://cursor.com/background-agent?bcId=bc-8230f382-ae7f-4966-9f1a-eca484c3c0da"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-cursor-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg"></picture></a>&nbsp;<a href="https://cursor.com/agents?id=bc-8230f382-ae7f-4966-9f1a-eca484c3c0da"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-web-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web" src="https://cursor.com/open-in-web.svg"></picture></a> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-16 02:16:49 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
enhancement
good first issue
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: run-llama/workflows-py#176
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?