Generate workflow server reference docs #160
Draft
Conversation
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
Introduce scripts/generate_server_reference_docs.py to transform the server OpenAPI schema into Markdown under docs/src/content/docs/workflows-api-reference. This enables publishing a browsable API reference in the Astro docs without adding new runtime deps. Also add Hatch scripts (server:reference, server:reference-all) to generate the OpenAPI and docs in one step.
Co-authored-by: adrian <[email protected]>
|
Cursor Agent can help with this pull request. Just |
Pull Request Test Coverage Report for Build 19036555772Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
- Make render_schema accept object and coerce to JSON-serializable types - Adjust resolve_ref return type to object - Remove unused op_id to satisfy lint
…ference Pre-commit was fixing end-of-file and formatting on the generated index.md. The generator now guarantees a trailing newline and the docs were regenerated.
|
@cursoragent update the schema references to be a more readable format, not just an inline json schema. |
|
Updated. I changed the generator to render schema refs in a readable format instead of raw JSON:
If anything else would help (e.g., deeper nesting or example blocks), I can adjust. Learn more about Cursor Agents |
Replace inline JSON dumps with human-friendly schema rendering: property tables for objects, concise type summaries for arrays/primitives, enum/default details, and oneOf/anyOf/allOf listings. Also link top-level $refs to component anchors and improve Components appendix formatting.
|
Cursor Agent can help with this pull request. Just |
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.
Add a script to generate Markdown reference docs for the workflows server API from its OpenAPI schema.
Linear Issue: LI-3952