Skip to content

OpenAPI spec: 6.1.5 review fixes that missed PR #108 - #112

Open
dennisdornon wants to merge 2 commits into
mainfrom
docs/openapi-6-1-5-fixes
Open

OpenAPI spec: 6.1.5 review fixes that missed PR #108#112
dennisdornon wants to merge 2 commits into
mainfrom
docs/openapi-6-1-5-fixes

Conversation

@dennisdornon

@dennisdornon dennisdornon commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

PR #108 merged before its final two review-fix commits landed, so the published spec is missing them. This carries those two commits unchanged:

  • Align the OpenAPI spec with released Dashboard 6.1.5 (removes endpoints and fields not present in the release)
  • Set spec version to 6.1.5, mark job timestamps nullable, fix ability wording

Files are byte-identical to the reviewed versions on the original branch.

Summary by CodeRabbit

  • Documentation
    • Updated API documentation for supported HTTP methods across monitoring and audit endpoints.
    • Clarified default date behavior for Pro Reports.
    • Documented the multi_tokens parameter.
    • Added documentation for widget activity, Page Speed activity, and multi-token reports.

Remove the unreleased GET /jobs/{id} route and point queued-work status
at the mainwp/get-batch-job-status-v1 ability; document POST/PUT/PATCH
on the SSL Monitor, Domain Monitor, and Lighthouse action routes; add
the widgets, pagespeed, and multi-tokens Pro Reports data sets, make
the date range optional with its one-year default, and model the
multi_tokens template parameter; widen success to [0, 1] only on the
envelopes whose handlers return 0 inside HTTP 200; correct ToolJobStatus
error and timestamp types; replace the fictional 403 responses with the
401 the auth layer actually returns. Same corrections applied to the
extensions.mdx route tables.
…rding

Bump the spec's info.version from the stale 6.1.3 to the released 6.1.5.
Allow null in ToolJobStatus started_at and completed_at: the disconnect
status handler reads a never-written started_at directly and falls back
to null for completed_at while the job runs, unlike the empty-string
fallback on the destroy and renew routes. Reword the queued-work notes:
the batch-status ability is served over the WordPress Abilities API
with WordPress authentication, so only a MainWP REST v2 route is
missing, not a REST endpoint altogether.
@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mainwp 🟢 Ready View Preview Aug 3, 2026, 6:43 PM

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6cbd3a3-aff4-4578-9485-c10fe079214a

📥 Commits

Reviewing files that changed from the base of the PR and between 95fa17a and b6186bc.

📒 Files selected for processing (2)
  • api-reference/openapi.yaml
  • api-reference/rest-api/extensions.mdx

Walkthrough

The REST API extension documentation now lists additional monitor methods, optional Pro Reports date parameters with a last-year default, the multi_tokens parameter, and three new Pro Reports routes.

Changes

REST API extension documentation

Layer / File(s) Summary
Endpoint reference updates
api-reference/rest-api/extensions.mdx
Monitor trigger routes now support POST, PUT, and PATCH. Pro Reports dates are optional and default to the last year when omitted. The multi_tokens parameter and widget activity, Page Speed activity, and multi-token resolution routes are documented.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • mainwp/docs#108: Both PRs update REST API extension endpoint documentation and Pro Reports details.
  • mainwp/docs#110: This PR overlaps with the same extension methods, Pro Reports parameters, and routes.

Suggested reviewers: bkatusic

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the OpenAPI specification review fixes for version 6.1.5 that were omitted from PR #108.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/openapi-6-1-5-fixes

Comment @coderabbitai help to get the list of available commands.

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