Operations API Migration#462
Conversation
Adds overview and operations reference for the Operations API section to the v4 consolidated reference structure. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-462 This preview will update automatically when you push new commits. |
kriszyp
left a comment
kriszyp
left a comment
There was a problem hiding this comment.
So we will have all the operations APIs in one page? That sounds good to me.
|
Yep! If a user doesn't find an operation in its relative section, at a minimum they can find the complete list here and then navigate to it. |
…tion into migration/operations-api
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-462 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-462 This preview will update automatically when you push new commits. |
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
2 participants
Operations API Migration
Summary
Migration of Operations API documentation from
versioned_docs/into the new v4 consolidated reference structure.Files Created
reference_versioned_docs/version-v4/operations-api/overview.mdreference_versioned_docs/version-v4/operations-api/operations.mdmigration-context/link-placeholders/operations-api-link-placeholders.mdFiles Modified
reference_versioned_sidebars/version-v4-sidebars.json— added Operations API category before LegacySource Files Used
reference_versioned_docs/version-v4/operations-api/overview.md
versioned_docs/version-4.7/developers/operations-api/index.md(primary)reference_versioned_docs/version-v4/operations-api/operations.md
versioned_docs/version-4.7/developers/operations-api/databases-and-tables.mdversioned_docs/version-4.7/developers/operations-api/nosql-operations.mdversioned_docs/version-4.7/developers/operations-api/bulk-operations.mdversioned_docs/version-4.7/developers/operations-api/sql-operations.mdversioned_docs/version-4.7/developers/operations-api/users-and-roles.mdversioned_docs/version-4.7/developers/operations-api/token-authentication.mdversioned_docs/version-4.7/developers/operations-api/components.mdversioned_docs/version-4.7/developers/operations-api/clustering.mdversioned_docs/version-4.7/developers/operations-api/configuration.mdversioned_docs/version-4.7/developers/operations-api/system-operations.mdversioned_docs/version-4.7/developers/operations-api/jobs.mdversioned_docs/version-4.7/developers/operations-api/logs.mdversioned_docs/version-4.7/developers/operations-api/certificate-management.mdversioned_docs/version-4.7/developers/operations-api/analytics.mdversioned_docs/version-4.7/developers/operations-api/registration.mdversioned_docs/version-4.7/developers/operations-api/custom-functions.md(deprecated operations)Version Annotations Added
High Confidence (Confirmed via release notes)
add_component,deploy_component, etc.): Added in v4.2.0 (component architecture)add_node,cluster_status, etc.): Added in v4.4.0 (Plexus native replication)add_certificate, etc.): Added in v4.4.0 (dynamic cert management)get_analytics,list_metrics, etc.): Added in v4.5.0 (resource/storage analytics)install_usage_license,get_usage_licenses): Added in v4.7.0 (new analytics/licensing)Needs Verification
search_by_conditionssort withnexttie-breaking: marked as needing version verificationStructure Decisions
operations.mdis a synthesized reference — it includes a quick-reference table plus abbreviated operation specs (body shape, key parameters) for each operation, withTODO:links pointing to the relevant feature section for full detail. This avoids duplicating content that lives in section-specific pages (e.g., full Users & Roles docs inusers-and-roles/operations.md).The NATS clustering operations (
clustering-nats.md) were not included — that content is legacy/deprecated per the replication migration (PR #461 removed all NATS/legacy clustering content). The modern clustering operations fromclustering.mdare included.Link Placeholders Created
See
migration-context/link-placeholders/operations-api-link-placeholders.mdfor the complete list.Summary:
overview.md(→ configuration, → security/basic-auth, → security/jwt-auth)operations.md(→ database, → rest/querying, → users-and-roles, → security, → components, → replication, → configuration, → logging, → analytics, → legacy/sql)Conflicts & Questions for Human Review
Content Conflicts
None — reference/ directory was not touched.
Uncertainties
clustering-nats.mdsource file exists but was excluded since the replication PR removed NATS content. If the NATS operations still need to be documented (for users on older versions), they should be added to the legacy section.search_by_conditionssortnextfield: Unsure exactly when multi-level tie-breaking sort was added — needs verification.Migration Map Status
Updated status for
reference/operations-api/overview.mdandreference/operations-api/operations.mdto "In Progress"Checklist for Human Reviewer
🤖 Generated with Claude Code