Skip to content

docs(openapi): add Human in the Loop section to API reference sidebar#4089

Merged
waleedlatif1 merged 1 commit intostagingfrom
waleedlatif1/krakow-v3
Apr 10, 2026
Merged

docs(openapi): add Human in the Loop section to API reference sidebar#4089
waleedlatif1 merged 1 commit intostagingfrom
waleedlatif1/krakow-v3

Conversation

@waleedlatif1
Copy link
Copy Markdown
Collaborator

Summary

  • Add (generated)/human-in-the-loop to the API reference sidebar navigation
  • Create meta.json listing all 5 HITL operation IDs so Fumadocs renders them in the docs

Follows up on #4079 which added the HITL endpoints to openapi.json — they weren't showing in the docs because the sidebar nav and generated folder config were missing.

Type of Change

  • Documentation update

Testing

Tested manually

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Add the generated human-in-the-loop group to the docs navigation
and create meta.json listing all HITL operation IDs so endpoints
render in the API reference.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

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

Project Deployment Actions Updated (UTC)
docs Building Building Preview, Comment Apr 10, 2026 1:51am

Request Review

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 10, 2026

PR Summary

Low Risk
Low risk documentation-only change that updates sidebar navigation and generated page listing; no runtime or API behavior changes.

Overview
Adds a new (generated)/human-in-the-loop section to the API Reference sidebar so Human-in-the-Loop endpoints appear in the docs.

Introduces apps/docs/content/docs/en/api-reference/(generated)/human-in-the-loop/meta.json to enumerate the 5 operation-ID pages (listPausedExecutions, getPausedExecution, getPausedExecutionByResumePath, getPauseContext, resumeExecution) for Fumadocs rendering.

Reviewed by Cursor Bugbot for commit 2e040da. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 10, 2026

Greptile Summary

This PR adds sidebar navigation and a generated folder config (meta.json) to surface the 5 Human-in-the-Loop API endpoints that were added to openapi.json in #4079. The two changed files are purely documentation metadata — no application logic is affected.

Confidence Score: 5/5

Safe to merge — documentation-only change with correct operation IDs and sidebar placement.

Both files are pure JSON metadata. All 5 operation IDs in the new meta.json exactly match the operationId values in openapi.json, and the sidebar entry follows the established pattern. No application logic is touched.

No files require special attention.

Important Files Changed

Filename Overview
apps/docs/content/docs/en/api-reference/(generated)/human-in-the-loop/meta.json New file listing all 5 HITL operation IDs; every ID matches the corresponding operationId in openapi.json.
apps/docs/content/docs/en/api-reference/meta.json Adds (generated)/human-in-the-loop to the sidebar between workflows and logs; follows the existing entry pattern correctly.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[API Reference Sidebar] --> B[Getting Started]
    A --> C[SDKs]
    A --> D[Endpoints]
    D --> E["(generated)/workflows"]
    D --> F["(generated)/human-in-the-loop NEW"]
    D --> G["(generated)/logs"]
    D --> H["(generated)/usage"]
    D --> I["(generated)/audit-logs"]
    D --> J["(generated)/tables"]
    D --> K["(generated)/files"]
    D --> L["(generated)/knowledge-bases"]
    F --> M[listPausedExecutions]
    F --> N[getPausedExecution]
    F --> O[getPausedExecutionByResumePath]
    F --> P[getPauseContext]
    F --> Q[resumeExecution]
Loading

Reviews (1): Last reviewed commit: "docs(openapi): add Human in the Loop sec..." | Re-trigger Greptile

@waleedlatif1 waleedlatif1 merged commit 476669f into staging Apr 10, 2026
11 of 12 checks passed
@waleedlatif1 waleedlatif1 deleted the waleedlatif1/krakow-v3 branch April 10, 2026 01:53
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