Skip to content

Add API reference docs for Runbooks REST API#73

Open
davi-maciel wants to merge 1 commit intomainfrom
docs/runbooks-rest-api-reference
Open

Add API reference docs for Runbooks REST API#73
davi-maciel wants to merge 1 commit intomainfrom
docs/runbooks-rest-api-reference

Conversation

@davi-maciel
Copy link
Contributor

Summary

  • Adds a new "API Reference for Runbooks" page documenting the two REST endpoints implemented in MER-6094
  • Documents POST /api/v1/runbook (create) and GET /api/v1/runbook/<runbook_number> (status)
  • Includes request/response schemas, error codes, status value definitions, and examples
  • Adds the page to SUMMARY.md under the Runbooks section

@davi-maciel davi-maciel force-pushed the docs/runbooks-rest-api-reference branch from 3402a61 to 7b5c2bc Compare March 6, 2026 00:38
@davi-maciel davi-maciel requested a review from simsinght March 6, 2026 18:37
Copy link

@simsinght simsinght left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't really tell me how i auth for this? at least a link to somewhere would be good if we have docs for it elsewhere.


<mark style="color:green;">`POST`</mark> `/api/v1/runbook`

This creates a new [<mark style="color:blue;">Runbook</mark>](concepts/architecture-overview.md) and triggers its execution asynchronously. The runbook is created using the provided prompt and repository, and the response includes the runbook number and a URL to track its progress.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk if Runbook needs to link to architecture overview

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.

2 participants