Skip to content

docs(collections): explain connector cleanup on deletion - #342

Open
adityamishra-hydradb wants to merge 2 commits into
mainfrom
vorflux/adityamishra/eng-3301-collection-delete-stops-connectors-docs-dco-v2
Open

adityamishra-hydradb wants to merge 2 commits into
mainfrom
vorflux/adityamishra/eng-3301-collection-delete-stops-connectors-docs-dco-v2

Conversation

@adityamishra-hydradb

@adityamishra-hydradb adityamishra-hydradb commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

For humans

The delete-collection reference now states that deletion removes dedicated connectors, disables matching defaults, and removes matching resources from mixed connectors.

Linear: https://linear.app/hydradb/issue/ENG-3301

Merge this PR only after the application change reaches production.

This PR replaces #340 because force-push is prohibited and its latest commit lacked DCO sign-off.

End-to-end proof

A disposable local A/B run verified the documented behavior. On origin/staging, deleting sales left the connector route active, and the next sync recreated sales. On the feature branch, cleanup removed C123 → sales, retained C456 → ops, and the next sync left sales absent.

Both deletes returned HTTP 200. Both sync requests returned HTTP 202 and completed in Temporal. No staging or production service was accessed.

Full proof, commands, and before/after screenshots: https://github.com/hydra-db/dashboard-2.0/pull/766#local-ab-sync-after-collection-deletion

Testing

Passed:

npm run hygiene:strict
npm run verify:agents-endpoints
npx mintlify validate

verify:agents-endpoints checked 54 endpoint mentions. DCO, Mintlify validation, hygiene, deployment, Greptile, and OpenHack checks passed.

No staging or production service was accessed.

Decisions taken without review

  • Added the lifecycle behavior to the canonical delete-collection endpoint reference next to the irreversible-data warning, because stopping connector routes is part of the endpoint's user-visible contract.
  • Described dedicated connector deletion, matching default-route disabling, and mixed-connector resource removal separately, because saying that deletion removes every connector would be inaccurate.
  • Kept implementation details such as route revisions, fences, and MOVEIT filtering out of the product documentation, because the endpoint reference should explain stable behavior rather than internal mechanisms.
  • Linked the full local A/B evidence from the PR body instead of embedding operational proof in the reference page, because verification details can change without changing the public API contract.

Risk Assessment

1/10 — documentation-only.

The endpoint schema did not change. The new sentence documents the verified cleanup semantics. Automated documentation validation passed.

Merge order

  1. Application
  2. Dashboard
  3. This docs PR after the application change reaches production

Session Details


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.


Devin Review

Signed-off-by: adityamishra-hydradb <321510987+adityamishra-hydradb@users.noreply.github.com>
@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
cortex-ai 🟢 Ready View Preview Oct 28, 2026, 7:50 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown

✅ Mintlify Hygiene

No issues found.

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

@greptileai review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

/devin review

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Starting Devin Review.

Devin Review

@openhack-agent

openhack-agent Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

✅ OpenHack Summary

Security review of docs(collections): explain connector cleanup on deletion. 1 changed file; 0 findings at or above the low reporting threshold.

P1: Critical 0   P2: High 0   P3: Medium 0   P4: Low 0

Confidence Score: 5/5

No reportable security findings were detected in this scan.

Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage.

Files Needing Attention: None

Important Files Changed
  • api-reference/v2/endpoint/delete-collection.mdx (modified)

Last reviewed commit: c35adb8 · View review on OpenHack


TIP: Mention @openhack-agent in a PR comment to request a review or ask a question. Use @openhack-agent fix all for every finding, or @openhack-agent fix unresolved threads for open review threads only.

@openhack-agent openhack-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

OpenHack reviewed this commit. See the OpenHack Summary for the confidence score and fix actions.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔍 Devin Review: 1 flag

Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)

Devin Review

@greptile-apps

greptile-apps Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation appears safe to merge after the application change reaches production, as required by the PR.

Summary

The delete-collection reference now explains three connector side effects:

  • The delete-collection guide now explains which connector routes are cleaned up.

The PR explicitly requires the application change to reach production before these docs merge. No actionable issues were found.

Reviews (2) · Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." · Reviewed by Greptile

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

@greptileai review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

/devin review

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Starting Devin Review.

Devin Review

…eng-3301-collection-delete-stops-connectors-docs-dco-v2

Signed-off-by: adityamishra-hydradb <321510987+adityamishra-hydradb@users.noreply.github.com>
@adityamishra-hydradb
adityamishra-hydradb force-pushed the vorflux/adityamishra/eng-3301-collection-delete-stops-connectors-docs-dco-v2 branch from 4afa938 to c35adb8 Compare October 28, 2026 19:48
@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

@greptileai review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

/devin review

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Starting Devin Review.

Devin Review

This branch was successfully deployed

1 active deployment
staging — c35adb8d Deployed Oct 28, 2026 by mintlify[bot]
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