From 50bd05db7d372a0c16eb9457399b0518984c64f9 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:05:00 -0600 Subject: [PATCH 01/13] docs(link-resolution): resolve link placeholders in CLI section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - cli/overview.md: resolved Operations API and Configuration links - cli/commands.md: resolved Configuration link - cli/operations-api-commands.md: resolved all TODO links; mapped operations table category links to operations-api/operations.md with anchors (no sub-pages exist); resolved Applications → components/overview.md Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/cli/commands.md | 4 +- .../version-v4/cli/operations-api-commands.md | 166 +++++++++--------- .../version-v4/cli/overview.md | 6 +- 3 files changed, 88 insertions(+), 88 deletions(-) diff --git a/reference_versioned_docs/version-v4/cli/commands.md b/reference_versioned_docs/version-v4/cli/commands.md index 7143f0a2..3f1fdc94 100644 --- a/reference_versioned_docs/version-v4/cli/commands.md +++ b/reference_versioned_docs/version-v4/cli/commands.md @@ -58,7 +58,7 @@ harper \ --ROOTPATH='/hdb' ``` -**Note**: When used in conjunction, command line arguments override environment variables. See [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration overview') for a full list of configuration parameters. +**Note**: When used in conjunction, command line arguments override environment variables. See [Configuration](../configuration/overview.md) for a full list of configuration parameters. :::info For more information on installation, see [Getting Started / Install and Connect Harper](/learn/getting-started/install-and-connect-harper). @@ -265,5 +265,5 @@ The CLI supports executing commands on remote Harper instances. For details, see - [CLI Overview](./overview.md) - General CLI information - [Operations API Commands](./operations-api-commands.md) - Operations available through CLI - [CLI Authentication](./authentication.md) - Authentication mechanisms -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration') - Configuration parameters for installation +- [Configuration](../configuration/overview.md) - Configuration parameters for installation - [Database Compaction](../database/compaction.md) - More on database compaction diff --git a/reference_versioned_docs/version-v4/cli/operations-api-commands.md b/reference_versioned_docs/version-v4/cli/operations-api-commands.md index 98bf0446..3b21ddb3 100644 --- a/reference_versioned_docs/version-v4/cli/operations-api-commands.md +++ b/reference_versioned_docs/version-v4/cli/operations-api-commands.md @@ -9,7 +9,7 @@ title: Operations API Commands Added in: v4.3.0 -The Harper CLI supports executing operations from the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') directly from the command line. This enables powerful automation and scripting capabilities. +The Harper CLI supports executing operations from the [Operations API](../operations-api/overview.md) directly from the command line. This enables powerful automation and scripting capabilities. ## General Syntax @@ -36,78 +36,78 @@ This is just a brief overview of all operations available as CLI commands. Revie | Operation | Description | Category | Available Since | | -------------------------------- | ------------------------------------- | ---------------------------------------------------------- | --------------- | -| `describe_table` | Describe table structure and metadata | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `describe_all` | Describe all databases and tables | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `describe_database` | Describe database structure | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `create_database` | Create a new database | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `drop_database` | Delete a database | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `create_table` | Create a new table | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `drop_table` | Delete a table | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `create_attribute` | Create a table attribute | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `drop_attribute` | Delete a table attribute | [Database](TODO:../operations-api/database.md) | v4.3.0 | -| `search_by_id` | Search records by ID | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `search_by_value` | Search records by attribute value | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `insert` | Insert new records | [Data](TODO:../operations-api/data.md) | v4.4.9 | -| `update` | Update existing records | [Data](TODO:../operations-api/data.md) | v4.4.9 | -| `upsert` | Insert or update records | [Data](TODO:../operations-api/data.md) | v4.4.9 | -| `delete` | Delete records | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `sql` | Execute SQL queries | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `csv_file_load` | Load data from CSV file | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `csv_url_load` | Load data from CSV URL | [Data](TODO:../operations-api/data.md) | v4.3.0 | -| `list_users` | List all users | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `add_user` | Create a new user | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `alter_user` | Modify user properties | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `drop_user` | Delete a user | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `list_roles` | List all roles | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `drop_role` | Delete a role | [Security](TODO:../operations-api/security.md) | v4.3.0 | -| `create_csr` | Create certificate signing request | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `sign_certificate` | Sign a certificate | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `list_certificates` | List SSL/TLS certificates | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `add_certificate` | Add SSL/TLS certificate | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `remove_certificate` | Remove SSL/TLS certificate | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `add_ssh_key` | Add SSH key | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `get_ssh_key` | Get SSH key | [Security](TODO:../operations-api/security.md) | v4.7.2 | -| `update_ssh_key` | Update SSH key | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `delete_ssh_key` | Delete SSH key | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `list_ssh_keys` | List all SSH keys | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `set_ssh_known_hosts` | Set SSH known hosts | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `get_ssh_known_hosts` | Get SSH known hosts | [Security](TODO:../operations-api/security.md) | v4.4.0 | -| `cluster_get_routes` | Get cluster routing information | [Clustering](TODO:../operations-api/clustering.md) | v4.3.0 | -| `cluster_network` | Get cluster network status | [Clustering](TODO:../operations-api/clustering.md) | v4.3.0 | -| `cluster_status` | Get cluster status | [Clustering](TODO:../operations-api/clustering.md) | v4.3.0 | -| `remove_node` | Remove node from cluster | [Clustering](TODO:../operations-api/clustering.md) | v4.3.0 | -| `add_component` | Add a component | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `deploy_component` | Deploy a component | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `deploy` (alias) | Alias for `deploy_component` | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `package_component` | Package a component | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `package` (alias) | Alias for `package_component` | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `drop_component` | Remove a component | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `get_components` | List all components | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `get_component_file` | Get component file contents | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `set_component_file` | Set component file contents | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `install_node_modules` | Install Node.js dependencies | [Components](TODO:../operations-api/components.md) | v4.3.0 | -| `set_configuration` | Update configuration settings | [Configuration](TODO:../operations-api/configuration.md) | v4.3.0 | -| `get_configuration` | Get current configuration | [Configuration](TODO:../operations-api/configuration.md) | v4.3.0 | -| `create_authentication_tokens` | Create authentication tokens | [Authentication](TODO:../operations-api/authentication.md) | v4.3.0 | -| `refresh_operation_token` | Refresh operation token | [Authentication](TODO:../operations-api/authentication.md) | v4.3.0 | -| `restart_service` | Restart Harper service | [System](TODO:../operations-api/system.md) | v4.3.0 | -| `restart` | Restart Harper instance | [System](TODO:../operations-api/system.md) | v4.3.0 | -| `system_information` | Get system information | [System](TODO:../operations-api/system.md) | v4.3.0 | -| `registration_info` | Get registration information | [Licensing](TODO:../operations-api/licensing.md) | v4.3.0 | -| `get_fingerprint` | Get instance fingerprint | [Licensing](TODO:../operations-api/licensing.md) | v4.3.0 | -| `set_license` | Set license key | [Licensing](TODO:../operations-api/licensing.md) | v4.3.0 | -| `get_usage_licenses` | Get usage and license info | [Licensing](TODO:../operations-api/licensing.md) | v4.7.3 | -| `get_job` | Get job status | [Jobs](TODO:../operations-api/jobs.md) | v4.3.0 | -| `search_jobs_by_start_date` | Search jobs by start date | [Jobs](TODO:../operations-api/jobs.md) | v4.3.0 | -| `read_log` | Read application logs | [Logging](TODO:../operations-api/logging.md) | v4.3.0 | -| `read_transaction_log` | Read transaction logs | [Logging](TODO:../operations-api/logging.md) | v4.3.0 | -| `read_audit_log` | Read audit logs | [Logging](TODO:../operations-api/logging.md) | v4.3.0 | -| `delete_transaction_logs_before` | Delete old transaction logs | [Logging](TODO:../operations-api/logging.md) | v4.3.0 | -| `purge_stream` | Purge streaming data | [Maintenance](TODO:../operations-api/maintenance.md) | v4.3.0 | -| `delete_records_before` | Delete old records | [Maintenance](TODO:../operations-api/maintenance.md) | v4.3.0 | -| `get_status` | Get custom status information | [Status](TODO:../operations-api/status.md) | v4.6.0 | -| `set_status` | Set custom status information | [Status](TODO:../operations-api/status.md) | v4.6.0 | -| `clear_status` | Clear custom status information | [Status](TODO:../operations-api/status.md) | v4.6.0 | +| `describe_table` | Describe table structure and metadata | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `describe_all` | Describe all databases and tables | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `describe_database` | Describe database structure | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_database` | Create a new database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_database` | Delete a database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_table` | Create a new table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_table` | Delete a table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_attribute` | Create a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_attribute` | Delete a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `search_by_id` | Search records by ID | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `search_by_value` | Search records by attribute value | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `insert` | Insert new records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `update` | Update existing records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `upsert` | Insert or update records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `delete` | Delete records | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `sql` | Execute SQL queries | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `csv_file_load` | Load data from CSV file | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `csv_url_load` | Load data from CSV URL | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `list_users` | List all users | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `add_user` | Create a new user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `alter_user` | Modify user properties | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `drop_user` | Delete a user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `list_roles` | List all roles | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `drop_role` | Delete a role | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `create_csr` | Create certificate signing request | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `sign_certificate` | Sign a certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `list_certificates` | List SSL/TLS certificates | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `add_certificate` | Add SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `remove_certificate` | Remove SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `add_ssh_key` | Add SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `get_ssh_key` | Get SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.7.2 | +| `update_ssh_key` | Update SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `delete_ssh_key` | Delete SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `list_ssh_keys` | List all SSH keys | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `set_ssh_known_hosts` | Set SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `get_ssh_known_hosts` | Get SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `cluster_get_routes` | Get cluster routing information | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `cluster_network` | Get cluster network status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `cluster_status` | Get cluster status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `remove_node` | Remove node from cluster | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `add_component` | Add a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `deploy_component` | Deploy a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `deploy` (alias) | Alias for `deploy_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `package_component` | Package a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `package` (alias) | Alias for `package_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `drop_component` | Remove a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `get_components` | List all components | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `get_component_file` | Get component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `set_component_file` | Set component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `install_node_modules` | Install Node.js dependencies | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `set_configuration` | Update configuration settings | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | +| `get_configuration` | Get current configuration | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | +| `create_authentication_tokens` | Create authentication tokens | [Authentication](../operations-api/operations.md#token-authentication) | v4.3.0 | +| `refresh_operation_token` | Refresh operation token | [Authentication](../operations-api/operations.md#token-authentication) | v4.3.0 | +| `restart_service` | Restart Harper service | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `restart` | Restart Harper instance | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `system_information` | Get system information | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `registration_info` | Get registration information | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `get_fingerprint` | Get instance fingerprint | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `set_license` | Set license key | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `get_usage_licenses` | Get usage and license info | [Licensing](../operations-api/operations.md#registration--licensing) | v4.7.3 | +| `get_job` | Get job status | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | +| `search_jobs_by_start_date` | Search jobs by start date | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | +| `read_log` | Read application logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `read_transaction_log` | Read transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `read_audit_log` | Read audit logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `delete_transaction_logs_before` | Delete old transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `purge_stream` | Purge streaming data | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | +| `delete_records_before` | Delete old records | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | +| `get_status` | Get custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | +| `set_status` | Set custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | +| `clear_status` | Clear custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | ### Command Aliases @@ -116,7 +116,7 @@ The following aliases are available for convenience: - `deploy` → `deploy_component` - `package` → `package_component` -For detailed parameter information for each operation, see the [Operations API documentation](TODO:reference_versioned_docs/version-v4/operations-api/operations.md 'Complete operations list'). +For detailed parameter information for each operation, see the [Operations API documentation](../operations-api/operations.md). ## Command Examples @@ -171,7 +171,7 @@ harper search_by_value table=dog search_attribute=name search_value=harper get_a ``` :::tip -For more information on querying data, see the [REST Reference](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST API reference') and [GraphQL Querying](../graphql-querying/overview.md). +For more information on querying data, see the [REST Reference](../rest/overview.md) and [GraphQL Querying](../graphql-querying/overview.md). ::: ### Configuration Operations @@ -189,7 +189,7 @@ harper get_configuration ``` :::tip -For comprehensive configuration options, see the [Configuration Reference](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration reference'). +For comprehensive configuration options, see the [Configuration Reference](../configuration/overview.md). ::: ### Component Operations @@ -213,7 +213,7 @@ harper deploy project=my-app package=https://github.com/user/repo ``` :::tip -For more information on components and applications, see the [Components Reference](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components reference'). +For more information on components and applications, see the [Components Reference](../components/overview.md). ::: ### User and Role Operations @@ -270,8 +270,8 @@ harper restart target=https://server.com:9925 replicated=true For more information on Harper applications and components, see: -- [Applications](TODO:reference_versioned_docs/version-v4/applications/overview.md 'Applications reference') - Application architecture and structure -- [Deploying Harper Applications](TODO:learn_link 'Deploying applications guide') - Step-by-step deployment guide +- [Components](../components/overview.md) - Application architecture and structure +- [Deploying Harper Applications](/learn/getting-started/install-and-connect-harper) - Step-by-step deployment guide ## Parameter Formatting @@ -295,7 +295,7 @@ harper search_by_id database=dev table=dog ids='["1","2","3"]' Object parameters are not supported via CLI. For operations requiring complex nested objects, use: -- The [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API') via HTTP +- The [Operations API](../operations-api/overview.md) via HTTP - A custom script or tool ### Boolean Parameters @@ -369,12 +369,12 @@ The following operation types are **not supported** via CLI: - File upload operations - Streaming operations -For these operations, use the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API') directly via HTTP. +For these operations, use the [Operations API](../operations-api/overview.md) directly via HTTP. ## See Also - [CLI Overview](./overview.md) - General CLI information - [CLI Commands](./commands.md) - Core CLI commands -- [Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') - Operations API documentation -- [Operations API Reference](TODO:reference_versioned_docs/version-v4/operations-api/operations.md 'Operations reference') - Complete operations list +- [Operations API Overview](../operations-api/overview.md) - Operations API documentation +- [Operations API Reference](../operations-api/operations.md) - Complete operations list - [CLI Authentication](./authentication.md) - Authentication details diff --git a/reference_versioned_docs/version-v4/cli/overview.md b/reference_versioned_docs/version-v4/cli/overview.md index 467cdc67..5571becc 100644 --- a/reference_versioned_docs/version-v4/cli/overview.md +++ b/reference_versioned_docs/version-v4/cli/overview.md @@ -115,7 +115,7 @@ See [CLI Commands](./commands.md) for detailed documentation on each command. Added in: v4.3.0 -The Harper CLI supports executing most operations from the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') directly from the command line. This includes operations that do not require complex nested parameters. +The Harper CLI supports executing most operations from the [Operations API](../operations-api/overview.md) directly from the command line. This includes operations that do not require complex nested parameters. **Syntax**: `harper =` @@ -196,5 +196,5 @@ See [CLI Commands](./commands.md) for detailed information on `harper dev` and o - [CLI Commands](./commands.md) - Detailed reference for each CLI command - [Operations API Commands](./operations-api-commands.md) - Operations available through CLI - [CLI Authentication](./authentication.md) - Authentication mechanisms -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration overview') - Harper configuration options -- [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API') - Full operations API reference +- [Configuration](../configuration/overview.md) - Harper configuration options +- [Operations API](../operations-api/overview.md) - Full operations API reference From 886c67828848eab90bed2200a6ff5b97c2cdf65d Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:06:11 -0600 Subject: [PATCH 02/13] docs(link-resolution): resolve link placeholders in Fastify Routes, Studio, GraphQL Querying - fastify-routes/overview.md: resolved Resources and REST overview links - studio/overview.md: resolved configuration options and Operations API links - graphql-querying/overview.md: resolved schema definition, Resources, and Resource Query API links Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/fastify-routes/overview.md | 4 ++-- .../version-v4/graphql-querying/overview.md | 4 ++-- reference_versioned_docs/version-v4/studio/overview.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/reference_versioned_docs/version-v4/fastify-routes/overview.md b/reference_versioned_docs/version-v4/fastify-routes/overview.md index 9ce54f8d..ddb5d3df 100644 --- a/reference_versioned_docs/version-v4/fastify-routes/overview.md +++ b/reference_versioned_docs/version-v4/fastify-routes/overview.md @@ -7,10 +7,10 @@ title: Define Fastify Routes # Define Fastify Routes :::note -Fastify routes are discouraged in favor of modern routing with [Custom Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources documentation'), but remain a supported feature for backwards compatibility and specific use cases. +Fastify routes are discouraged in favor of modern routing with [Custom Resources](../resources/overview.md), but remain a supported feature for backwards compatibility and specific use cases. ::: -Harper provides a build-in plugin for loading [Fastify](https://www.fastify.io/) routes as a way to define custom endpoints for your Harper application. While we generally recommend building your endpoints/APIs with Harper's [REST interface](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST interface documentation') for better performance and standards compliance, Fastify routes can provide an extensive API for highly customized path handling. Below is a very simple example of a route declaration. +Harper provides a build-in plugin for loading [Fastify](https://www.fastify.io/) routes as a way to define custom endpoints for your Harper application. While we generally recommend building your endpoints/APIs with Harper's [REST interface](../rest/overview.md) for better performance and standards compliance, Fastify routes can provide an extensive API for highly customized path handling. Below is a very simple example of a route declaration. The fastify route handler can be configured in your application's config.yaml (this is the default config if you used the [application template](https://github.com/HarperDB/application-template)): diff --git a/reference_versioned_docs/version-v4/graphql-querying/overview.md b/reference_versioned_docs/version-v4/graphql-querying/overview.md index 8e4bbf6d..625281bc 100644 --- a/reference_versioned_docs/version-v4/graphql-querying/overview.md +++ b/reference_versioned_docs/version-v4/graphql-querying/overview.md @@ -14,7 +14,7 @@ Added in: v4.4.0 (provisional) Changed in: v4.5.0 (disabled by default, configuration options) -Harper supports GraphQL in a variety of ways. It can be used for [defining schemas](TODO:reference_versioned_docs/version-v4/components/applications.md 'Schema definition documentation'), and for querying [Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources overview'). +Harper supports GraphQL in a variety of ways. It can be used for [defining schemas](../components/applications.md), and for querying [Resources](../resources/overview.md). Get started by setting `graphql: true` in `config.yaml`. This configuration option was added in v4.5.0 to allow more granular control over the GraphQL endpoint. @@ -56,7 +56,7 @@ Accept: application/graphql-response+json > Tip: For the best user experience, include the `Accept: application/graphql-response+json` header in your request. This provides better status codes for errors. -The Harper GraphQL querying system is strictly limited to exported Harper Resources. This will typically be a table that uses the `@exported` directive in its schema or `export`'ed custom resources. Queries can only specify Harper Resources and their attributes in the selection set. Queries can filter using [arguments](https://graphql.org/learn/queries/#arguments) on the top-level Resource field. Harper provides a short form pattern for simple queries, and a long form pattern based off of the [Resource Query API](TODO:reference_versioned_docs/version-v4/resources/overview.md#query 'Resource Query API') for more complex queries. +The Harper GraphQL querying system is strictly limited to exported Harper Resources. This will typically be a table that uses the `@exported` directive in its schema or `export`'ed custom resources. Queries can only specify Harper Resources and their attributes in the selection set. Queries can filter using [arguments](https://graphql.org/learn/queries/#arguments) on the top-level Resource field. Harper provides a short form pattern for simple queries, and a long form pattern based off of the [Resource Query API](../resources/overview.md#query) for more complex queries. Unlike REST queries, GraphQL queries can specify multiple resources simultaneously: diff --git a/reference_versioned_docs/version-v4/studio/overview.md b/reference_versioned_docs/version-v4/studio/overview.md index c904413d..c6096e3e 100644 --- a/reference_versioned_docs/version-v4/studio/overview.md +++ b/reference_versioned_docs/version-v4/studio/overview.md @@ -17,14 +17,14 @@ If you're looking for the platform as a service interface, go to [Harper Fabric] ## Configuration -To enable the local Studio, set `localStudio.enabled` to `true` in your [configuration file](TODO:reference_versioned_docs/version-v4/configuration/options.md#localstudio 'Configuration options'): +To enable the local Studio, set `localStudio.enabled` to `true` in your [configuration file](../configuration/options.md#localstudio): ```yaml localStudio: enabled: true ``` -The local studio is provided by the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') and is available on the configured `operationsApi.port` or `operationsApi.securePort` values. This is `9925` by default. +The local studio is provided by the [Operations API](../operations-api/overview.md) and is available on the configured `operationsApi.port` or `operationsApi.securePort` values. This is `9925` by default. ## Accessing Local Studio From 64a6e85b69af2b76720bb3e77d5986559ed9faba Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:08:31 -0600 Subject: [PATCH 03/13] docs(link-resolution): resolve link placeholders in Env Vars, Static Files, HTTP, MQTT - environment-variables/overview.md: resolved Configuration and Components links - static-files/overview.md: resolved all Components overview links - http/overview.md: resolved REST Overview link - http/configuration.md: resolved Configuration Overview link - http/tls.md: resolved Operations API Configuration links (x2) - http/api.md: resolved Operations API and REST Overview links - mqtt/overview.md: resolved REST Overview link - mqtt/configuration.md: resolved Configuration Overview link Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/environment-variables/overview.md | 6 +++--- reference_versioned_docs/version-v4/http/api.md | 4 ++-- reference_versioned_docs/version-v4/http/configuration.md | 2 +- reference_versioned_docs/version-v4/http/overview.md | 2 +- reference_versioned_docs/version-v4/http/tls.md | 4 ++-- reference_versioned_docs/version-v4/mqtt/configuration.md | 2 +- reference_versioned_docs/version-v4/mqtt/overview.md | 2 +- .../version-v4/static-files/overview.md | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/reference_versioned_docs/version-v4/environment-variables/overview.md b/reference_versioned_docs/version-v4/environment-variables/overview.md index 2b66a486..0c72b83b 100644 --- a/reference_versioned_docs/version-v4/environment-variables/overview.md +++ b/reference_versioned_docs/version-v4/environment-variables/overview.md @@ -10,7 +10,7 @@ title: Environment Variables Harper supports loading environment variables in Harper applications `process.env` using the built-in `loadEnv` plugin. This is the standard way to supply secrets and configuration to your Harper components without hardcoding values. `loadEnv` does **not** need to be installed as it is built into Harper and only needs to be declared in your `config.yaml`. :::note -If you are looking for information on how to configure your Harper installation using environment variables, see [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration section overview, including environment variable configuration') section for more information. +If you are looking for information on how to configure your Harper installation using environment variables, see [Configuration](../configuration/overview.md) section for more information. ::: ## Basic Usage @@ -73,5 +73,5 @@ Files are loaded in the order specified. ## Related -- [Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Extensions overview') -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration section, including environment variable configuration conventions and HARPER_DEFAULT_CONFIG / HARPER_SET_CONFIG') +- [Components Overview](../components/overview.md) +- [Configuration](../configuration/overview.md) diff --git a/reference_versioned_docs/version-v4/http/api.md b/reference_versioned_docs/version-v4/http/api.md index 2690913e..bde865df 100644 --- a/reference_versioned_docs/version-v4/http/api.md +++ b/reference_versioned_docs/version-v4/http/api.md @@ -294,7 +294,7 @@ server.resources.getMatch('/NewResource/some-id', 'rest'); ## `server.operation(operation, context?, authorize?)` -Execute an [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') operation programmatically. +Execute an [Operations API](../operations-api/overview.md) operation programmatically. ```ts server.operation(operation: object, context?: { username: string }, authorize?: boolean): Promise @@ -397,5 +397,5 @@ contentTypes.set('text/xml', { - [HTTP Overview](./overview) - [HTTP Configuration](./configuration) -- [REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST interface overview') +- [REST Overview](../rest/overview.md) - [Security API](../security/api.md) diff --git a/reference_versioned_docs/version-v4/http/configuration.md b/reference_versioned_docs/version-v4/http/configuration.md index dc4e2b84..abc21a29 100644 --- a/reference_versioned_docs/version-v4/http/configuration.md +++ b/reference_versioned_docs/version-v4/http/configuration.md @@ -339,4 +339,4 @@ tls: - [HTTP API](./api) - [TLS Configuration](./tls) - [Security Overview](../security/overview.md) -- [Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Full configuration reference') +- [Configuration Overview](../configuration/overview.md) diff --git a/reference_versioned_docs/version-v4/http/overview.md b/reference_versioned_docs/version-v4/http/overview.md index 86568c16..6199689f 100644 --- a/reference_versioned_docs/version-v4/http/overview.md +++ b/reference_versioned_docs/version-v4/http/overview.md @@ -60,5 +60,5 @@ HTTP request logging is not enabled by default. To enable it, add an `http.loggi - [HTTP Configuration](./configuration) - [HTTP API](./api) -- [REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST interface overview') +- [REST Overview](../rest/overview.md) - [Security Overview](../security/overview.md) diff --git a/reference_versioned_docs/version-v4/http/tls.md b/reference_versioned_docs/version-v4/http/tls.md index 2fbaa4b3..7f9ff399 100644 --- a/reference_versioned_docs/version-v4/http/tls.md +++ b/reference_versioned_docs/version-v4/http/tls.md @@ -8,7 +8,7 @@ title: TLS Configuration Harper uses a top-level `tls` section in `harperdb-config.yaml` to configure Transport Layer Security. This configuration is shared by the HTTP server (HTTPS), the MQTT broker (secure MQTT), and any TLS socket servers created via the [HTTP API](./api#serversocketlistener-options). -The `operationsApi` section can optionally define its own `tls` block, which overrides the root `tls` for Operations API traffic only. See the [Operations API Configuration](TODO:reference_versioned_docs/version-v4/configuration/operations.md 'Operations API configuration reference') for more details. +The `operationsApi` section can optionally define its own `tls` block, which overrides the root `tls` for Operations API traffic only. See the [Operations API Configuration](../configuration/operations.md) for more details. Harper must be restarted for TLS configuration changes to take effect. @@ -110,7 +110,7 @@ operationsApi: privateKey: ~/hdb/keys/ops-privateKey.pem ``` -See the [Operations API Configuration](TODO:reference_versioned_docs/version-v4/configuration/operations.md 'Operations API configuration reference') for more details. +See the [Operations API Configuration](../configuration/operations.md) for more details. ## Related diff --git a/reference_versioned_docs/version-v4/mqtt/configuration.md b/reference_versioned_docs/version-v4/mqtt/configuration.md index 3053344f..93205ee9 100644 --- a/reference_versioned_docs/version-v4/mqtt/configuration.md +++ b/reference_versioned_docs/version-v4/mqtt/configuration.md @@ -228,4 +228,4 @@ tls: - [MQTT Overview](./overview) - [TLS Configuration](../http/tls.md) - [Security Overview](../security/overview.md) -- [Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Full harperdb-config.yaml reference') +- [Configuration Overview](../configuration/overview.md) diff --git a/reference_versioned_docs/version-v4/mqtt/overview.md b/reference_versioned_docs/version-v4/mqtt/overview.md index 829730b7..3da53187 100644 --- a/reference_versioned_docs/version-v4/mqtt/overview.md +++ b/reference_versioned_docs/version-v4/mqtt/overview.md @@ -139,4 +139,4 @@ Available events: - [HTTP Overview](../http/overview.md) - [Security Overview](../security/overview.md) - [Database Schema](../database/schema.md) -- [REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST interface — same path conventions as MQTT topics') +- [REST Overview](../rest/overview.md) diff --git a/reference_versioned_docs/version-v4/static-files/overview.md b/reference_versioned_docs/version-v4/static-files/overview.md index 053a8f5d..2d0ea9f5 100644 --- a/reference_versioned_docs/version-v4/static-files/overview.md +++ b/reference_versioned_docs/version-v4/static-files/overview.md @@ -46,7 +46,7 @@ Files are accessed relative to the matched directory root, so `GET /index.html` Added in: v4.5 -`static` is a [Plugin](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview') and supports the standard `files` and `urlPath` configuration options for controlling which files to serve and at what URL path. +`static` is a [Plugin](../components/overview.md) and supports the standard `files` and `urlPath` configuration options for controlling which files to serve and at what URL path. Use `urlPath` to mount the files at a specific URL prefix: @@ -58,7 +58,7 @@ static: Now `GET /app/index.html` returns `site/index.html` and `GET /app/blog/post-1.html` returns `site/blog/post-1.html`. -See [Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview — files and urlPath options') for full `files` glob pattern and `urlPath` documentation. +See [Components Overview](../components/overview.md) for full `files` glob pattern and `urlPath` documentation. ## Additional Options @@ -171,4 +171,4 @@ A request to any unmatched path returns `static/index.html` with a `200` status ## Related -- [Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview — including files/urlPath options') +- [Components Overview](../components/overview.md) From 92d7caa154cad82fe74b96c0ead3401d4d9e828d Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:09:50 -0600 Subject: [PATCH 04/13] docs(link-resolution): resolve link placeholders in Logging and Analytics - logging/configuration.md: resolved Configuration Overview link - logging/operations.md: resolved Operations API Overview link - analytics/overview.md: resolved Configuration Overview links (x2) - analytics/operations.md: resolved search_by_conditions and Operations API Overview links Co-Authored-By: Claude Sonnet 4.6 --- reference_versioned_docs/version-v4/analytics/operations.md | 4 ++-- reference_versioned_docs/version-v4/analytics/overview.md | 4 ++-- reference_versioned_docs/version-v4/logging/configuration.md | 2 +- reference_versioned_docs/version-v4/logging/operations.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/reference_versioned_docs/version-v4/analytics/operations.md b/reference_versioned_docs/version-v4/analytics/operations.md index c5449b04..db17194c 100644 --- a/reference_versioned_docs/version-v4/analytics/operations.md +++ b/reference_versioned_docs/version-v4/analytics/operations.md @@ -90,7 +90,7 @@ Queries analytics data for a specific metric over a time range. | `start_time` | No | number | Start of time range as Unix timestamp in milliseconds | | `end_time` | No | number | End of time range as Unix timestamp in milliseconds | | `get_attributes` | No | string[] | Attributes to include in each result. If omitted, all attributes are returned | -| `conditions` | No | object[] | Additional filter conditions. Same format as [`search_by_conditions`](TODO:reference_versioned_docs/version-v4/operations-api/operations.md 'Operations API — search_by_conditions') | +| `conditions` | No | object[] | Additional filter conditions. Same format as [`search_by_conditions`](../operations-api/operations.md#nosql-operations) | ### Request @@ -133,4 +133,4 @@ Queries analytics data for a specific metric over a time range. ## Related - [Analytics Overview](./overview) -- [Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Full Operations API reference') +- [Operations API Overview](../operations-api/overview.md) diff --git a/reference_versioned_docs/version-v4/analytics/overview.md b/reference_versioned_docs/version-v4/analytics/overview.md index 6dd7a4f2..679e70f4 100644 --- a/reference_versioned_docs/version-v4/analytics/overview.md +++ b/reference_versioned_docs/version-v4/analytics/overview.md @@ -195,7 +195,7 @@ Applications can record custom metrics using the `server.recordAnalytics()` API. ## Analytics Configuration -The `analytics.aggregatePeriod` configuration option controls how frequently aggregate summaries are written. See [Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Full harperdb-config.yaml reference') for details. +The `analytics.aggregatePeriod` configuration option controls how frequently aggregate summaries are written. See [Configuration Overview](../configuration/overview.md) for details. Per-component analytics logging can be configured via `analytics.logging`. See [Logging Configuration](../logging/configuration.md) for details. @@ -204,4 +204,4 @@ Per-component analytics logging can be configured via `analytics.logging`. See [ - [Analytics Operations](./operations) - [HTTP API](../http/api.md) - [Logging Configuration](../logging/configuration.md) -- [Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Full configuration reference') +- [Configuration Overview](../configuration/overview.md) diff --git a/reference_versioned_docs/version-v4/logging/configuration.md b/reference_versioned_docs/version-v4/logging/configuration.md index 659296fd..d32b0f28 100644 --- a/reference_versioned_docs/version-v4/logging/configuration.md +++ b/reference_versioned_docs/version-v4/logging/configuration.md @@ -367,4 +367,4 @@ http: - [Logging API](./api) - [Logging Operations](./operations) - [Database / Transaction Logging](../database/transaction.md) -- [Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Full harperdb-config.yaml reference') +- [Configuration Overview](../configuration/overview.md) diff --git a/reference_versioned_docs/version-v4/logging/operations.md b/reference_versioned_docs/version-v4/logging/operations.md index b4dbab5f..de149d62 100644 --- a/reference_versioned_docs/version-v4/logging/operations.md +++ b/reference_versioned_docs/version-v4/logging/operations.md @@ -88,4 +88,4 @@ _Restricted to super_user roles only._ - [Logging Overview](./overview) - [Logging Configuration](./configuration) - [Database / Transaction Logging](../database/transaction.md) -- [Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md 'Operations API overview') +- [Operations API Overview](../operations-api/overview.md) From 42ca25292f1e0b80ce77ed067a0d40bc69e748ae Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:10:46 -0600 Subject: [PATCH 05/13] docs(link-resolution): resolve link placeholders in Security - security/overview.md: resolved Configuration Operations links (CORS network, TLS) - security/mtls-authentication.md: resolved Replication clustering link - security/certificate-verification.md: resolved Replication clustering link - security/certificate-management.md: resolved Replication clustering link Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/security/certificate-management.md | 2 +- .../version-v4/security/certificate-verification.md | 2 +- .../version-v4/security/mtls-authentication.md | 2 +- reference_versioned_docs/version-v4/security/overview.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/reference_versioned_docs/version-v4/security/certificate-management.md b/reference_versioned_docs/version-v4/security/certificate-management.md index 7beb1585..79f254b8 100644 --- a/reference_versioned_docs/version-v4/security/certificate-management.md +++ b/reference_versioned_docs/version-v4/security/certificate-management.md @@ -7,7 +7,7 @@ title: Certificate Management -This page covers certificate management for Harper's external-facing HTTP and Operations APIs. For replication certificate management, see [Replication Certificate Management](TODO:reference_versioned_docs/version-v4/replication/clustering.md 'Replication clustering and certificate management'). +This page covers certificate management for Harper's external-facing HTTP and Operations APIs. For replication certificate management, see [Replication Certificate Management](../replication/clustering.md). ## Default Behavior diff --git a/reference_versioned_docs/version-v4/security/certificate-verification.md b/reference_versioned_docs/version-v4/security/certificate-verification.md index 7a719585..e2ee6ad2 100644 --- a/reference_versioned_docs/version-v4/security/certificate-verification.md +++ b/reference_versioned_docs/version-v4/security/certificate-verification.md @@ -446,4 +446,4 @@ replication: mTLS is always required for replication and cannot be disabled. This configuration only controls whether certificate revocation checking is performed. -For complete replication configuration, see [Replication Configuration](TODO:reference_versioned_docs/version-v4/replication/clustering.md 'Replication clustering configuration'). +For complete replication configuration, see [Replication Configuration](../replication/clustering.md). diff --git a/reference_versioned_docs/version-v4/security/mtls-authentication.md b/reference_versioned_docs/version-v4/security/mtls-authentication.md index e194714d..d1f202e9 100644 --- a/reference_versioned_docs/version-v4/security/mtls-authentication.md +++ b/reference_versioned_docs/version-v4/security/mtls-authentication.md @@ -77,4 +77,4 @@ For help generating and managing certificates, see [Certificate Management](./ce ## Replication -mTLS is always required for Harper replication and cannot be disabled. For replication-specific mTLS configuration, see [Replication Configuration](TODO:reference_versioned_docs/version-v4/replication/clustering.md 'Replication clustering configuration'). +mTLS is always required for Harper replication and cannot be disabled. For replication-specific mTLS configuration, see [Replication Configuration](../replication/clustering.md). diff --git a/reference_versioned_docs/version-v4/security/overview.md b/reference_versioned_docs/version-v4/security/overview.md index c2ddd569..8cc9a671 100644 --- a/reference_versioned_docs/version-v4/security/overview.md +++ b/reference_versioned_docs/version-v4/security/overview.md @@ -35,10 +35,10 @@ Harper supports three authentication methods: - CORS — Cross-Origin Resource Sharing. - For HTTP server configuration see [HTTP / Configuration / CORS](../http/configuration.md#cors) - - For Operations API configuration see [Operations API / Configuration / Network](TODO:reference_versioned_docs/version-v4/configuration/operations.md#network) + - For Operations API configuration see [Operations API / Configuration / Network](../configuration/operations.md#network) - SSL & HTTPS — Enabling HTTPS and configuring TLS for the HTTP server. - For HTTP server configuration see [HTTP / Configuration / TLS](../http/tls.md) - - For Operations API configuration see [Operations API / Configuration / TLS](TODO:reference_versioned_docs/version-v4/configuration/operations.md#tls) + - For Operations API configuration see [Operations API / Configuration / TLS](../configuration/operations.md#tls) - [Users and Roles](../users-and-roles/overview.md) — Role-Based Access Control (RBAC): defining roles, assigning permissions, and managing users. ## API From 9fe5dac7d47891bc82a67e7ab86bce5e05b0fe6a Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:12:47 -0600 Subject: [PATCH 06/13] docs(link-resolution): resolve link placeholders in REST, Components, Resources, Replication - rest/websockets.md: resolved Resource API and Resources overview links - rest/server-sent-events.md: resolved Resources overview link - components/overview.md: fixed malformed TODO-as-link-text for Resource API and Schema links - components/extension-api.md: resolved server global API link - components/plugin-api.md: resolved Resource API and server global API links - resources/overview.md: resolved REST Overview and MQTT Overview links - resources/query-optimization.md: resolved Schema documentation link - replication/overview.md: resolved Certificate Verification and Certificate Management links Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/components/extension-api.md | 2 +- reference_versioned_docs/version-v4/components/overview.md | 4 ++-- reference_versioned_docs/version-v4/components/plugin-api.md | 4 ++-- reference_versioned_docs/version-v4/replication/overview.md | 4 ++-- reference_versioned_docs/version-v4/resources/overview.md | 4 ++-- .../version-v4/resources/query-optimization.md | 2 +- .../version-v4/rest/server-sent-events.md | 2 +- reference_versioned_docs/version-v4/rest/websockets.md | 4 ++-- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/reference_versioned_docs/version-v4/components/extension-api.md b/reference_versioned_docs/version-v4/components/extension-api.md index 09fa8770..5d729cf6 100644 --- a/reference_versioned_docs/version-v4/components/extension-api.md +++ b/reference_versioned_docs/version-v4/components/extension-api.md @@ -141,7 +141,7 @@ Parameters: A Protocol Extension is a more advanced form of Resource Extension, primarily used for implementing higher-level protocols (e.g., building and running a Next.js project) or adding custom networking handlers. -Protocol Extensions use the [`server`](TODO:reference_versioned_docs/version-v4/http/api.md 'HTTP server global API') global API for custom networking. +Protocol Extensions use the [`server`](../http/api.md) global API for custom networking. ### Protocol Extension Configuration diff --git a/reference_versioned_docs/version-v4/components/overview.md b/reference_versioned_docs/version-v4/components/overview.md index 2dfe8d1d..d41b7475 100644 --- a/reference_versioned_docs/version-v4/components/overview.md +++ b/reference_versioned_docs/version-v4/components/overview.md @@ -166,5 +166,5 @@ Harper collects status from each component at load time and tracks any registere - [Applications](./applications.md) — Managing and deploying applications - [Extension API](./extension-api.md) — Building custom extensions - [Plugin API](./plugin-api.md) — Building plugins (experimental, recommended for new extensions) -- [TODO:reference_versioned_docs/version-v4/resources/resource-api.md](TODO:reference_versioned_docs/version-v4/resources/resource-api.md 'Resource API reference') — Resource class interface -- [TODO:reference_versioned_docs/version-v4/database/schema.md](TODO:reference_versioned_docs/version-v4/database/schema.md 'Schema definition') — Defining schemas with graphqlSchema +- [Resource API](../resources/resource-api.md) — Resource class interface +- [Database Schema](../database/schema.md) — Defining schemas with graphqlSchema diff --git a/reference_versioned_docs/version-v4/components/plugin-api.md b/reference_versioned_docs/version-v4/components/plugin-api.md index e91e2ded..750c8a8e 100644 --- a/reference_versioned_docs/version-v4/components/plugin-api.md +++ b/reference_versioned_docs/version-v4/components/plugin-api.md @@ -159,11 +159,11 @@ Request a Harper restart. Does not restart immediately—indicates to the user t #### `scope.resources` -Returns: `Map` — Currently loaded [Resource](TODO:reference_versioned_docs/version-v4/resources/resource-api.md 'Resource API') instances. +Returns: `Map` — Currently loaded [Resource](../resources/resource-api.md) instances. #### `scope.server` -Returns: `server` — Reference to the [server](TODO:reference_versioned_docs/version-v4/http/api.md 'HTTP server global API') global API. Use for registering HTTP middleware, custom networking, etc. +Returns: `server` — Reference to the [server](../http/api.md) global API. Use for registering HTTP middleware, custom networking, etc. #### `scope.options` diff --git a/reference_versioned_docs/version-v4/replication/overview.md b/reference_versioned_docs/version-v4/replication/overview.md index 3a5012f7..c89a38f1 100644 --- a/reference_versioned_docs/version-v4/replication/overview.md +++ b/reference_versioned_docs/version-v4/replication/overview.md @@ -80,7 +80,7 @@ Harper supports PKI-based security and authorization for replication connections - **Certificate-based authentication** (recommended for production): Nodes are identified by the certificate's common name (CN) or Subject Alternative Names (SANs). - **IP-based authentication** (for development/testing): Nodes are identified by IP address when using insecure connections. -Harper can automatically perform CRL (Certificate Revocation List) and OCSP (Online Certificate Status Protocol) verification to ensure revoked certificates cannot be used. OCSP and CRL work automatically with certificates from public CAs when `enableRootCAs` is enabled. For self-signed certificates or private CAs without OCSP/CRL support, use Harper's manual certificate revocation feature. Certificate verification settings follow the same configuration as HTTP mTLS connections (see [Certificate Verification](TODO:reference_versioned_docs/version-v4/security/certificate-verification.md 'HTTP mTLS certificate verification configuration')). +Harper can automatically perform CRL (Certificate Revocation List) and OCSP (Online Certificate Status Protocol) verification to ensure revoked certificates cannot be used. OCSP and CRL work automatically with certificates from public CAs when `enableRootCAs` is enabled. For self-signed certificates or private CAs without OCSP/CRL support, use Harper's manual certificate revocation feature. Certificate verification settings follow the same configuration as HTTP mTLS connections (see [Certificate Verification](../security/certificate-verification.md)). ### Providing Your Own Certificates @@ -306,4 +306,4 @@ The `hdb_certificate` table contains the certificates used for replication conne - [Clustering Operations](./clustering.md) — Operations API for managing cluster nodes and subscriptions - [Sharding](./sharding.md) — Distributing data across a subset of nodes -- [Certificate Management](TODO:reference_versioned_docs/version-v4/security/certificate-management.md 'Dynamic certificate management for replication') +- [Certificate Management](../security/certificate-management.md) diff --git a/reference_versioned_docs/version-v4/resources/overview.md b/reference_versioned_docs/version-v4/resources/overview.md index c8fa7e41..1530192b 100644 --- a/reference_versioned_docs/version-v4/resources/overview.md +++ b/reference_versioned_docs/version-v4/resources/overview.md @@ -20,8 +20,8 @@ The Resource API is designed to mirror REST/HTTP semantics: methods map directly ## Relationship to Other Features - **Database tables** extend `Resource` automatically. You can use tables through the Resource API without writing any custom code. -- The **REST plugin** maps incoming HTTP requests to Resource methods. See [REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md 'REST plugin reference'). -- The **MQTT plugin** routes publish/subscribe messages to `publish` and `subscribe` Resource methods. See [MQTT Overview](TODO:reference_versioned_docs/version-v4/mqtt/overview.md 'MQTT plugin reference'). +- The **REST plugin** maps incoming HTTP requests to Resource methods. See [REST Overview](../rest/overview.md). +- The **MQTT plugin** routes publish/subscribe messages to `publish` and `subscribe` Resource methods. See [MQTT Overview](../mqtt/overview.md). - **Global APIs** (`tables`, `databases`, `transaction`) provide access to resources from JavaScript code. - The **`jsResource` plugin** (configured in `config.yaml`) registers a JavaScript file's exported Resource classes as endpoints. diff --git a/reference_versioned_docs/version-v4/resources/query-optimization.md b/reference_versioned_docs/version-v4/resources/query-optimization.md index 36a00675..6501565a 100644 --- a/reference_versioned_docs/version-v4/resources/query-optimization.md +++ b/reference_versioned_docs/version-v4/resources/query-optimization.md @@ -66,7 +66,7 @@ More unique values (higher cardinality) = more efficient indexed lookups. For ex ## Relationships and Joins -Harper supports relationship-based queries that join data across tables. See [Schema documentation](TODO:reference_versioned_docs/version-v4/database/schema.md 'Database schema section with relationship directives') for how to define relationships. +Harper supports relationship-based queries that join data across tables. See [Schema documentation](../database/schema.md) for how to define relationships. Join queries involve more lookups and naturally carry more overhead. The same indexing principles apply: diff --git a/reference_versioned_docs/version-v4/rest/server-sent-events.md b/reference_versioned_docs/version-v4/rest/server-sent-events.md index e7decfde..bdffaa1f 100644 --- a/reference_versioned_docs/version-v4/rest/server-sent-events.md +++ b/reference_versioned_docs/version-v4/rest/server-sent-events.md @@ -61,4 +61,4 @@ SSE is simpler to implement and has built-in reconnection in browsers. For scena - [WebSockets](./websockets.md) — Bidirectional real-time connections - [MQTT Overview](../mqtt/overview.md) — Full MQTT pub/sub documentation - [REST Overview](./overview.md) — HTTP methods and URL structure -- [Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources overview') — Custom resource API including `connect()` +- [Resources](../resources/overview.md) — Custom resource API including `connect()` diff --git a/reference_versioned_docs/version-v4/rest/websockets.md b/reference_versioned_docs/version-v4/rest/websockets.md index e38925b4..005b6795 100644 --- a/reference_versioned_docs/version-v4/rest/websockets.md +++ b/reference_versioned_docs/version-v4/rest/websockets.md @@ -36,7 +36,7 @@ By default, `new WebSocket('wss://server/my-resource/341')` accesses the resourc ## Custom `connect()` Handler -WebSocket behavior is driven by the `connect(incomingMessages)` method on a resource class. The method must return an async iterable (or generator) that produces messages to send to the client. For more on implementing custom resources, see [Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md 'Resource API reference'). +WebSocket behavior is driven by the `connect(incomingMessages)` method on a resource class. The method must return an async iterable (or generator) that produces messages to send to the client. For more on implementing custom resources, see [Resource API](../resources/resource-api.md). **Simple echo server**: @@ -103,4 +103,4 @@ In a scenario where messages arrive out-of-order across nodes: - [Server-Sent Events](./server-sent-events.md) — One-way real-time streaming - [MQTT Overview](../mqtt/overview.md) — Full MQTT pub/sub documentation - [REST Overview](./overview.md) — HTTP methods and URL structure -- [Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources overview') — Custom resource API including `connect()` +- [Resources](../resources/overview.md) — Custom resource API including `connect()` From debf25a2b2e1fc81d43dc3ecbf01a19484e235ca Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:15:35 -0600 Subject: [PATCH 07/13] docs(link-resolution): resolve link placeholders in Database section - database/overview.md: resolved Resource API, Resources, Operations API, Configuration links - database/schema.md: resolved Operations API, Resources, Configuration links - database/api.md: resolved Resource API (x3) and Configuration links - database/data-loader.md: resolved Extension API and Components links - database/storage-algorithm.md: resolved Configuration links (x2) - database/jobs.md: resolved Operations API links (x2) - database/system-tables.md: resolved Replication clustering, Replication overview, Operations API links - database/compaction.md: resolved Configuration link - database/transaction.md: resolved Replication and Operations API links Co-Authored-By: Claude Sonnet 4.6 --- reference_versioned_docs/version-v4/database/api.md | 8 ++++---- .../version-v4/database/compaction.md | 2 +- .../version-v4/database/data-loader.md | 4 ++-- reference_versioned_docs/version-v4/database/jobs.md | 4 ++-- reference_versioned_docs/version-v4/database/overview.md | 8 ++++---- reference_versioned_docs/version-v4/database/schema.md | 6 +++--- .../version-v4/database/storage-algorithm.md | 4 ++-- .../version-v4/database/system-tables.md | 6 +++--- .../version-v4/database/transaction.md | 4 ++-- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/reference_versioned_docs/version-v4/database/api.md b/reference_versioned_docs/version-v4/database/api.md index 93162ed6..bb8c225d 100644 --- a/reference_versioned_docs/version-v4/database/api.md +++ b/reference_versioned_docs/version-v4/database/api.md @@ -12,7 +12,7 @@ Harper exposes a set of global variables and functions that JavaScript code (in ## `tables` -`tables` is an object whose properties are the tables in the default database (`data`). Each table defined in your `schema.graphql` file is available as a property, and the value is the table class that implements the [Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md). +`tables` is an object whose properties are the tables in the default database (`data`). Each table defined in your `schema.graphql` file is available as a property, and the value is the table class that implements the [Resource API](../resources/resource-api.md). ```graphql # schema.graphql @@ -49,7 +49,7 @@ for await (const record of Product.search(query)) { } ``` -For the full set of methods available on table classes, see the [Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md). +For the full set of methods available on table classes, see the [Resource API](../resources/resource-api.md). ## `databases` @@ -238,6 +238,6 @@ When a field is typed as `Blob` in the schema, any string or buffer assigned via ## Related Documentation - [Schema](./schema.md) — Defining tables and blob fields -- [Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md) — Full table class method reference +- [Resource API](../resources/resource-api.md) — Full table class method reference - [Transaction Logging](./transaction.md) — Audit log and transaction log for data change history -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md) — Blob storage path configuration +- [Configuration](../configuration/options.md) — Blob storage path configuration diff --git a/reference_versioned_docs/version-v4/database/compaction.md b/reference_versioned_docs/version-v4/database/compaction.md index 152a9ab4..a4ede5f2 100644 --- a/reference_versioned_docs/version-v4/database/compaction.md +++ b/reference_versioned_docs/version-v4/database/compaction.md @@ -68,4 +68,4 @@ STORAGE_COMPACTONSTART=true STORAGE_COMPACTONSTARTKEEPBACKUP=true harperdb - [Storage Algorithm](./storage-algorithm.md) — How Harper stores data using LMDB - [CLI Commands](../cli/commands.md) — `copy-db` CLI command reference -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md 'storage section') — Full storage configuration options including compression settings +- [Configuration](../configuration/options.md) — Full storage configuration options including compression settings diff --git a/reference_versioned_docs/version-v4/database/data-loader.md b/reference_versioned_docs/version-v4/database/data-loader.md index 521f6153..962b3706 100644 --- a/reference_versioned_docs/version-v4/database/data-loader.md +++ b/reference_versioned_docs/version-v4/database/data-loader.md @@ -20,7 +20,7 @@ dataLoader: files: 'data/*.json' ``` -`dataLoader` is an [Extension](TODO:reference_versioned_docs/version-v4/components/extension-api.md 'Extension component API') and supports the standard `files` configuration option, including glob patterns. +`dataLoader` is an [Extension](../components/extension-api.md) and supports the standard `files` configuration option, including glob patterns. ## Data File Format @@ -213,4 +213,4 @@ Because the data loader uses content hashing, adding new countries or correcting - [Schema](./schema.md) — Defining table structure before loading data - [Jobs](./jobs.md) — Bulk data operations via the Operations API (CSV/JSON import from file, URL, or S3) -- [Components](TODO:reference_versioned_docs/version-v4/components/overview.md) — Extension and plugin system that the data loader is built on +- [Components](../components/overview.md) — Extension and plugin system that the data loader is built on diff --git a/reference_versioned_docs/version-v4/database/jobs.md b/reference_versioned_docs/version-v4/database/jobs.md index 5931746c..63fd8e0e 100644 --- a/reference_versioned_docs/version-v4/database/jobs.md +++ b/reference_versioned_docs/version-v4/database/jobs.md @@ -17,7 +17,7 @@ Job status values: ## Bulk Operations -The following operations create jobs. All bulk operations are sent to the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md). +The following operations create jobs. All bulk operations are sent to the [Operations API](../operations-api/overview.md). ### CSV Data Load @@ -268,5 +268,5 @@ _Restricted to `super_user` roles._ ## Related Documentation - [Data Loader](./data-loader.md) — Component-based data loading as part of deployment -- [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md) — Sending operations to Harper +- [Operations API](../operations-api/overview.md) — Sending operations to Harper - [Transaction Logging](./transaction.md) — Recording a history of changes made to tables diff --git a/reference_versioned_docs/version-v4/database/overview.md b/reference_versioned_docs/version-v4/database/overview.md index af5b8471..8025d577 100644 --- a/reference_versioned_docs/version-v4/database/overview.md +++ b/reference_versioned_docs/version-v4/database/overview.md @@ -31,7 +31,7 @@ The most common way to use Harper's database is through the **schema system**. B You do not need to build custom application code to use the database. A schema definition alone is enough to create fully functional, queryable REST endpoints for your data. -For more advanced use cases, you can extend table behavior using the [Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md 'Custom resource logic layered on top of tables'). +For more advanced use cases, you can extend table behavior using the [Resource API](../resources/resource-api.md). ### Architecture Overview @@ -118,6 +118,6 @@ For deeper coverage of each database feature, see the dedicated pages in this se ## Related Documentation - [REST](../rest/overview.md) — HTTP interface built on top of the database resource system -- [Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md) — Custom application logic extending database tables -- [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md) — Direct database management operations (create/drop databases and tables, insert/update/delete records) -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md) — Storage configuration options (compression, blob paths, compaction) +- [Resources](../resources/overview.md) — Custom application logic extending database tables +- [Operations API](../operations-api/overview.md) — Direct database management operations (create/drop databases and tables, insert/update/delete records) +- [Configuration](../configuration/overview.md) — Storage configuration options (compression, blob paths, compaction) diff --git a/reference_versioned_docs/version-v4/database/schema.md b/reference_versioned_docs/version-v4/database/schema.md index 93cb5b7f..905aa1f9 100644 --- a/reference_versioned_docs/version-v4/database/schema.md +++ b/reference_versioned_docs/version-v4/database/schema.md @@ -477,7 +477,7 @@ When a table is created through the Operations API or Studio without a schema de Dynamic schema tables are additive — new attributes are added as new data arrives. Existing records will have `null` for any newly added attributes. -Use `create_attribute` and `drop_attribute` operations to manually manage attributes on dynamic schema tables. See the [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/operations.md 'NoSQL and database operations') for details. +Use `create_attribute` and `drop_attribute` operations to manually manage attributes on dynamic schema tables. See the [Operations API](../operations-api/operations.md#databases--tables) for details. ## OpenAPI Specification @@ -498,6 +498,6 @@ Harper does **not** support renaming tables. Changing a type name in a schema de - [JavaScript API](./api.md) — `tables`, `databases`, `transaction()`, and `createBlob()` globals for working with schema-defined tables in code - [Data Loader](./data-loader.md) — Seed tables with initial data alongside schema deployment - [REST Querying](../rest/querying.md) — Querying tables via HTTP using schema-defined attributes and relationships -- [Resources](TODO:reference_versioned_docs/version-v4/resources/resource-api.md) — Extending table behavior with custom application logic +- [Resources](../resources/resource-api.md) — Extending table behavior with custom application logic - [Storage Algorithm](./storage-algorithm.md) — How Harper indexes and stores schema-defined data -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md 'graphqlSchema component and storage options') — Component configuration for schemas +- [Configuration](../configuration/options.md) — Component configuration for schemas diff --git a/reference_versioned_docs/version-v4/database/storage-algorithm.md b/reference_versioned_docs/version-v4/database/storage-algorithm.md index 346f2cb4..35af971b 100644 --- a/reference_versioned_docs/version-v4/database/storage-algorithm.md +++ b/reference_versioned_docs/version-v4/database/storage-algorithm.md @@ -44,7 +44,7 @@ Within the LMDB implementation, table records are grouped into a single LMDB env Changed in: v4.3.0 — Compression is now enabled by default for all records over 4KB -Harper compresses record data automatically for records over 4KB. Compression settings can be configured in the [storage configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md 'storage configuration options'). Note that compression settings cannot be changed on existing databases without creating a new compacted copy — see [Compaction](./compaction.md). +Harper compresses record data automatically for records over 4KB. Compression settings can be configured in the [storage configuration](../configuration/options.md). Note that compression settings cannot be changed on existing databases without creating a new compacted copy — see [Compaction](./compaction.md). ## Performance Characteristics @@ -108,4 +108,4 @@ Indexes are ordered — booleans first, then numbers (numerically), then strings - [Schema](./schema.md) — Defining indexed attributes and vector indexes - [Compaction](./compaction.md) — Reclaiming free space and applying new storage configuration to existing databases -- [Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md 'storage section') — Storage configuration options (compression, memory maps, blob paths) +- [Configuration](../configuration/options.md) — Storage configuration options (compression, memory maps, blob paths) diff --git a/reference_versioned_docs/version-v4/database/system-tables.md b/reference_versioned_docs/version-v4/database/system-tables.md index 6b457e9f..683dfb6e 100644 --- a/reference_versioned_docs/version-v4/database/system-tables.md +++ b/reference_versioned_docs/version-v4/database/system-tables.md @@ -144,7 +144,7 @@ Can be queried to inspect the current replication topology: } ``` -Used by the `add_node`, `update_node`, and related clustering operations. See [Replication](TODO:reference_versioned_docs/version-v4/replication/clustering.md 'Clustering and node management') for details. +Used by the `add_node`, `update_node`, and related clustering operations. See [Replication](../replication/clustering.md) for details. ### `hdb_certificate` @@ -154,5 +154,5 @@ Stores TLS certificates used in replication. Can be queried to inspect the certi - [Analytics](../analytics/overview.md) — Full reference for analytics metrics tracked in `hdb_analytics` and `hdb_raw_analytics` - [Data Loader](./data-loader.md) — Component that writes to `hdb_dataloader_hash` -- [Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md) — Clustering and replication system that uses `hdb_nodes` and `hdb_certificate` -- [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md) — Querying system tables using `search_by_conditions` +- [Replication](../replication/overview.md) — Clustering and replication system that uses `hdb_nodes` and `hdb_certificate` +- [Operations API](../operations-api/overview.md) — Querying system tables using `search_by_conditions` diff --git a/reference_versioned_docs/version-v4/database/transaction.md b/reference_versioned_docs/version-v4/database/transaction.md index d2a58968..3ae8847f 100644 --- a/reference_versioned_docs/version-v4/database/transaction.md +++ b/reference_versioned_docs/version-v4/database/transaction.md @@ -149,6 +149,6 @@ This overrides the [`logging.auditLog`](../logging/configuration.md) global conf ## Related Documentation - [Logging](../logging/overview.md) — Application and system logging (separate from transaction/audit logging) -- [Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md) — Clustering setup required for transaction logs +- [Replication](../replication/overview.md) — Clustering setup required for transaction logs - [Logging Configuration](../logging/configuration.md) — Global audit log configuration (`logging.auditLog`) -- [Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md) — Sending operations to Harper +- [Operations API](../operations-api/overview.md) — Sending operations to Harper From 2447760ec5f7ec74598f33e4e84004e992245ba0 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:17:12 -0600 Subject: [PATCH 08/13] docs(link-resolution): resolve link placeholders in Operations API and Configuration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - operations-api/overview.md: resolved Configuration Overview link - operations-api/operations.md: resolved SQL (→ database/sql.md) and Configuration links - configuration/operations.md: resolved restart and restart_service operation links Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/configuration/operations.md | 2 +- .../version-v4/operations-api/operations.md | 4 ++-- .../version-v4/operations-api/overview.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/reference_versioned_docs/version-v4/configuration/operations.md b/reference_versioned_docs/version-v4/configuration/operations.md index 23361381..c6056ef1 100644 --- a/reference_versioned_docs/version-v4/configuration/operations.md +++ b/reference_versioned_docs/version-v4/configuration/operations.md @@ -16,7 +16,7 @@ For the full list of configurable options, see [Configuration Options](./options ## Set Configuration -Modifies one or more Harper configuration parameters. **Requires a [restart](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart 'restart operation') or [restart_service](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart-service 'restart_service operation') to take effect.** +Modifies one or more Harper configuration parameters. **Requires a [restart](../operations-api/operations.md#restart) or [restart_service](../operations-api/operations.md#restart-service) to take effect.** `operation` _(required)_ — must be `set_configuration` diff --git a/reference_versioned_docs/version-v4/operations-api/operations.md b/reference_versioned_docs/version-v4/operations-api/operations.md index d6219815..690aeecd 100644 --- a/reference_versioned_docs/version-v4/operations-api/operations.md +++ b/reference_versioned_docs/version-v4/operations-api/operations.md @@ -390,7 +390,7 @@ Operations for executing SQL statements. Harper SQL is intended for data investigation and use cases where performance is not a priority. For production workloads, use NoSQL or REST operations. SQL performance optimizations are on the roadmap. ::: -Detailed documentation: [TODO:reference_versioned_docs/version-v4/legacy/sql 'Legacy SQL reference'] +Detailed documentation: [SQL Reference](../database/sql.md) | Operation | Description | Role Required | | --------- | ------------------------------------------------------------------ | ------------- | @@ -684,7 +684,7 @@ Resets and replaces the entire clustering configuration. Each entry follows the Operations for reading and updating Harper configuration. -Detailed documentation: [TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration overview'] +Detailed documentation: [Configuration Overview](../configuration/overview.md) | Operation | Description | Role Required | | ------------------- | ---------------------------------------------------------------- | ------------- | diff --git a/reference_versioned_docs/version-v4/operations-api/overview.md b/reference_versioned_docs/version-v4/operations-api/overview.md index 969d21ab..711d6ebb 100644 --- a/reference_versioned_docs/version-v4/operations-api/overview.md +++ b/reference_versioned_docs/version-v4/operations-api/overview.md @@ -16,7 +16,7 @@ All Operations API requests are sent as HTTP POST requests to the Operations API POST http://:9925/ ``` -See [TODO:reference_versioned_docs/version-v4/configuration/overview.md 'Configuration overview'] for how to change the port and other network settings (`operationsApi.network.port`, `operationsApi.network.securePort`). +See [Configuration Overview](../configuration/overview.md) for how to change the port and other network settings (`operationsApi.network.port`, `operationsApi.network.securePort`). ## Request Format From c7de8e6dc7322e8be4c661450a54ab22b25f494c Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:18:01 -0600 Subject: [PATCH 09/13] docs(link-resolution): delete resolved link placeholder tracker files All link placeholders have been resolved. Removing tracker files now that link resolution is complete. Co-Authored-By: Claude Sonnet 4.6 --- .../analytics-link-placeholders.md | 26 -- .../cli-link-placeholders.md | 282 ------------------ .../components-link-placeholders.md | 65 ---- .../configuration-link-placeholders.md | 61 ---- .../database-link-placeholders.md | 135 --------- ...environment-variables-link-placeholders.md | 19 -- .../fastify-routes-link-placeholders.md | 11 - .../graphql-querying-link-placeholders.md | 14 - .../http-link-placeholders.md | 48 --- .../logging-link-placeholders.md | 34 --- .../mqtt-link-placeholders.md | 32 -- .../operations-api-link-placeholders.md | 131 -------- .../replication-link-placeholders.md | 11 - .../resources-link-placeholders.md | 21 -- .../rest-link-placeholders.md | 39 --- .../security-link-placeholders.md | 31 -- .../static-files-link-placeholders.md | 15 - .../studio-link-placeholders.md | 11 - 18 files changed, 986 deletions(-) delete mode 100644 migration-context/link-placeholders/analytics-link-placeholders.md delete mode 100644 migration-context/link-placeholders/cli-link-placeholders.md delete mode 100644 migration-context/link-placeholders/components-link-placeholders.md delete mode 100644 migration-context/link-placeholders/configuration-link-placeholders.md delete mode 100644 migration-context/link-placeholders/database-link-placeholders.md delete mode 100644 migration-context/link-placeholders/environment-variables-link-placeholders.md delete mode 100644 migration-context/link-placeholders/fastify-routes-link-placeholders.md delete mode 100644 migration-context/link-placeholders/graphql-querying-link-placeholders.md delete mode 100644 migration-context/link-placeholders/http-link-placeholders.md delete mode 100644 migration-context/link-placeholders/logging-link-placeholders.md delete mode 100644 migration-context/link-placeholders/mqtt-link-placeholders.md delete mode 100644 migration-context/link-placeholders/operations-api-link-placeholders.md delete mode 100644 migration-context/link-placeholders/replication-link-placeholders.md delete mode 100644 migration-context/link-placeholders/resources-link-placeholders.md delete mode 100644 migration-context/link-placeholders/rest-link-placeholders.md delete mode 100644 migration-context/link-placeholders/security-link-placeholders.md delete mode 100644 migration-context/link-placeholders/static-files-link-placeholders.md delete mode 100644 migration-context/link-placeholders/studio-link-placeholders.md diff --git a/migration-context/link-placeholders/analytics-link-placeholders.md b/migration-context/link-placeholders/analytics-link-placeholders.md deleted file mode 100644 index aaaeab94..00000000 --- a/migration-context/link-placeholders/analytics-link-placeholders.md +++ /dev/null @@ -1,26 +0,0 @@ -# Link Placeholders for Analytics Section - -## reference_versioned_docs/version-v4/analytics/overview.md - -- ~~Line 99: `[server.recordAnalytics()](TODO:reference_versioned_docs/version-v4/http/api.md)`~~ **RESOLVED** → `../http/api.md#serverrecordanalyticsvalue-metric-path-method-type` -- ~~Line 103: `[HTTP API](TODO:reference_versioned_docs/version-v4/http/api.md)`~~ **RESOLVED** → `../http/api.md` -- ~~Line 105: `[Logging Configuration](TODO:reference_versioned_docs/version-v4/logging/configuration.md)`~~ **RESOLVED** → `../logging/configuration.md` -- ~~Line 110: `[HTTP API](TODO:reference_versioned_docs/version-v4/http/api.md)`~~ **RESOLVED** → `../http/api.md` -- ~~Line 111: `[Logging Configuration](TODO:reference_versioned_docs/version-v4/logging/configuration.md)`~~ **RESOLVED** → `../logging/configuration.md` - -- Line 106 + 112: `[Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: analytics.aggregatePeriod configuration + related section - - Target should be: Configuration section overview page - - **Status**: PENDING (Configuration section migration) - -## reference_versioned_docs/version-v4/analytics/operations.md - -- Line 56: `[search_by_conditions](TODO:reference_versioned_docs/version-v4/operations-api/operations.md)` - - Context: Note that `conditions` parameter uses the same format as search_by_conditions - - Target should be: Operations API operations page - - **Status**: PENDING (Operations API section migration) - -- Line 77: `[Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Related section at bottom of file - - Target should be: Operations API section overview page - - **Status**: PENDING (Operations API section migration) diff --git a/migration-context/link-placeholders/cli-link-placeholders.md b/migration-context/link-placeholders/cli-link-placeholders.md deleted file mode 100644 index fb3f79d3..00000000 --- a/migration-context/link-placeholders/cli-link-placeholders.md +++ /dev/null @@ -1,282 +0,0 @@ -# Link Placeholders for CLI Section - -This document tracks all link placeholders in the CLI section that need to be resolved once other sections are migrated. - -## reference_versioned_docs/version-v4/cli/overview.md - -- Line 30: `[CLI Authentication](TODO:reference_versioned_docs/version-v4/cli/authentication.md "CLI authentication details")` - - Context: Linking to CLI authentication details - - Target: CLI authentication page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 45: `[CLI Commands](TODO:reference_versioned_docs/version-v4/cli/commands.md "Detailed CLI command reference")` - - Context: Linking to detailed CLI commands - - Target: CLI commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 60: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")` - - Context: Linking to Operations API overview - - Target: Operations API section overview page - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 100: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API CLI commands reference")` - - Context: Linking to operations API commands via CLI - - Target: Operations API commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 126: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration overview")` - - Context: Linking to configuration options - - Target: Configuration section overview - - **Status**: PENDING (will be created in Configuration section migration) - -- Line 144: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API")` - - Context: Linking to full operations API reference - - Target: Operations API section overview page - - **Status**: PENDING (will be created in Operations API section migration) - -## reference_versioned_docs/version-v4/cli/commands.md - -- Line 9: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API CLI commands")` - - Context: Referring users to operations API commands documentation - - Target: Operations API commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 52: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration overview")` - - Context: Linking to configuration parameters - - Target: Configuration section overview - - **Status**: PENDING (will be created in Configuration section migration) - -- Line 125: `[Database Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md "Database compaction reference")` - - Context: Linking to database compaction details - - Target: Database section compaction page - - **Status**: PENDING (will be created in Database section migration) - -- Line 146: `[CLI Overview - Remote Operations](TODO:reference_versioned_docs/version-v4/cli/overview.md#remote-operations "Remote operations documentation")` - - Context: Linking to remote operations section in overview - - Target: CLI overview page, remote operations section - - **Status**: RESOLVED (file created in this migration) - -- Line 151: `[CLI Overview](TODO:reference_versioned_docs/version-v4/cli/overview.md "CLI overview")` - - Context: Linking back to CLI overview - - Target: CLI overview page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 152: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API commands")` - - Context: Linking to operations API commands - - Target: Operations API commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 153: `[CLI Authentication](TODO:reference_versioned_docs/version-v4/cli/authentication.md "CLI authentication")` - - Context: Linking to authentication mechanisms - - Target: CLI authentication page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 154: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration")` - - Context: Linking to configuration parameters - - Target: Configuration section overview - - **Status**: PENDING (will be created in Configuration section migration) - -- Line 155: `[Database Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md "Compaction")` - - Context: Linking to compaction details - - Target: Database section compaction page - - **Status**: PENDING (will be created in Database section migration) - -## reference_versioned_docs/version-v4/cli/operations-api-commands.md - -- Line 12: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")` - - Context: Introduction paragraph - - Target: Operations API section overview page - - **Status**: PENDING (will be created in Operations API section migration) - -- Lines 38-109: 72 operations table entries with category links - - `[Database](TODO:../operations-api/database.md)` (9 operations) - - `[Data](TODO:../operations-api/data.md)` (9 operations) - - `[Security](TODO:../operations-api/security.md)` (17 operations) - - `[Clustering](TODO:../operations-api/clustering.md)` (4 operations) - - `[Components](TODO:../operations-api/components.md)` (9 operations) - - `[Configuration](TODO:../operations-api/configuration.md)` (2 operations) - - `[Authentication](TODO:../operations-api/authentication.md)` (2 operations) - - `[System](TODO:../operations-api/system.md)` (3 operations) - - `[Licensing](TODO:../operations-api/licensing.md)` (4 operations) - - `[Jobs](TODO:../operations-api/jobs.md)` (2 operations) - - `[Logging](TODO:../operations-api/logging.md)` (4 operations) - - `[Maintenance](TODO:../operations-api/maintenance.md)` (2 operations) - - `[Status](TODO:../operations-api/status.md)` (3 operations) - - Context: Operations table linking to operation category documentation - - Target: Operations API section category pages - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 118: `[Operations API documentation](TODO:reference_versioned_docs/version-v4/operations-api/operations.md "Complete operations list")` - - Context: After Command Aliases section - - Target: Operations API section operations page - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 150: `[Database Reference](TODO:reference_versioned_docs/version-v4/database/overview.md "Database reference documentation")` - - Context: Tip callout in Database Operations examples - - Target: Database section overview - - **Status**: PENDING (will be created in Database section migration) - -- Line 168: `[REST Reference](TODO:reference_versioned_docs/version-v4/rest/overview.md "REST API reference")` - - Context: Tip callout in Data Operations examples - - Target: REST section overview - - **Status**: PENDING (will be created in REST section migration) - -- Line 168: `[GraphQL Querying](TODO:reference_versioned_docs/version-v4/graphql-querying/overview.md "GraphQL querying reference")` - - Context: Tip callout in Data Operations examples - - Target: GraphQL Querying section overview - - **Status**: PENDING (will be created in GraphQL Querying section migration) - -- Line 186: `[Configuration Reference](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration reference")` - - Context: Tip callout in Configuration Operations examples - - Target: Configuration section overview - - **Status**: PENDING (will be created in Configuration section migration) - -- Line 204: `[Components Reference](TODO:reference_versioned_docs/version-v4/components/overview.md "Components reference")` - - Context: Tip callout in Component Operations examples - - Target: Components section overview - - **Status**: PENDING (will be created in Components section migration) - -- Line 222: `[Security Reference](TODO:reference_versioned_docs/version-v4/security/overview.md "Security reference")` - - Context: Tip callout in User and Role Operations examples - - Target: Security section overview - - **Status**: PENDING (will be created in Security section migration) - -- Line 227: `[CLI Overview - Remote Operations](./overview.md#remote-operations)` - - Context: Remote Operations section - - Target: CLI overview page, remote operations anchor - - **Status**: RESOLVED (file created in this migration) - -- Line 245: `[Applications](TODO:reference_versioned_docs/version-v4/applications/overview.md "Applications reference")` - - Context: Remote Component Deployment section - - Target: Applications section (or Components section) - - **Status**: PENDING (will be created in future section migration) - -- Line 246: `[Deploying Harper Applications](TODO:learn_link "Deploying applications guide")` - - Context: Remote Component Deployment section - - Target: Learn guide on deploying applications - - **Status**: PENDING (external learn link) - -- Line 372: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API")` - - Context: Limitations section - - Target: Operations API section overview page - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 376: `[CLI Overview](./overview.md)` - - Context: See Also section - - Target: CLI overview page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 377: `[CLI Commands](./commands.md)` - - Context: See Also section - - Target: CLI commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 378: `[Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")` - - Context: See Also section - - Target: Operations API section overview page - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 379: `[Operations API Reference](TODO:reference_versioned_docs/version-v4/operations-api/operations.md "Operations reference")` - - Context: See Also section - - Target: Operations API section operations page - - **Status**: PENDING (will be created in Operations API section migration) - -- Line 380: `[CLI Authentication](./authentication.md)` - - Context: See Also section - - Target: CLI authentication page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -## reference_versioned_docs/version-v4/cli/authentication.md - -- Line 196: `[Users and Roles](TODO:reference_versioned_docs/version-v4/security/users-and-roles.md "Users and roles documentation")` - - Context: Linking to user management and permissions (Security Best Practices section) - - Target: Users and Roles section overview (moved to top-level section) - - **Status**: ~~RESOLVED~~ → `../users-and-roles/overview.md` - -- Line 204: `[Logging](TODO:reference_versioned_docs/version-v4/logging/overview.md "Logging documentation")` - - Context: Linking to audit logging information (Security Best Practices section) - - Target: Logging section overview - - **Status**: ~~RESOLVED~~ → `../logging/overview.md` - -- Line 256: `[CLI Overview](./overview.md)` - - Context: See Also section - - Target: CLI overview page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 257: `[CLI Commands](./commands.md)` - - Context: See Also section - - Target: CLI commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 258: `[Operations API Commands](./operations-api-commands.md)` - - Context: See Also section - - Target: Operations API commands page (within CLI section) - - **Status**: RESOLVED (file created in this migration) - -- Line 259: `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md "Security overview")` - - Context: See Also section - - Target: Security section overview page - - **Status**: ~~RESOLVED~~ → `../security/overview.md` - -- Line 260: `[Users and Roles](TODO:reference_versioned_docs/version-v4/security/users-and-roles.md "Users and roles")` - - Context: See Also section - - Target: Users and Roles section overview (moved to top-level section) - - **Status**: ~~RESOLVED~~ → `../users-and-roles/overview.md` - -## Summary - -### Resolved Links - -- 12 links to pages within the CLI section (resolved in initial migration) -- `../logging/overview.md` — resolved -- `../security/overview.md` — resolved (×2) -- `../users-and-roles/overview.md` — resolved (×2, was `security/users-and-roles.md`) -- `../graphql-querying/overview.md` — resolved (×1, in operations-api-commands.md) - -### Pending Links (Cross-Section References) - -**Operations API Section** (~82 links): - -- `reference_versioned_docs/version-v4/operations-api/overview.md` (5 occurrences) -- `reference_versioned_docs/version-v4/operations-api/operations.md` (2 occurrences) -- Operations table category pages (72 links): - - `../operations-api/database.md` - - `../operations-api/data.md` - - `../operations-api/security.md` - - `../operations-api/clustering.md` - - `../operations-api/components.md` - - `../operations-api/configuration.md` - - `../operations-api/authentication.md` - - `../operations-api/system.md` - - `../operations-api/licensing.md` - - `../operations-api/jobs.md` - - `../operations-api/logging.md` - - `../operations-api/maintenance.md` - - `../operations-api/status.md` - -**Configuration Section** (5 links): - -- `reference_versioned_docs/version-v4/configuration/overview.md` - -**Database Section** (3 links): - -- `reference_versioned_docs/version-v4/database/compaction.md` (2 occurrences) -- `reference_versioned_docs/version-v4/database/overview.md` (1 occurrence) - -**Components Section** (1 link): - -- `reference_versioned_docs/version-v4/components/overview.md` - -**REST Section** (1 link): - -- `reference_versioned_docs/version-v4/rest/overview.md` - -**Applications / Components Section** (1 link): - -- `reference_versioned_docs/version-v4/applications/overview.md` (note: this should likely be `components/overview.md`) - -**Learn Guides** (1 link): - -- Deploying Harper Applications guide (external learn link) - -**Total Pending Links**: ~89 diff --git a/migration-context/link-placeholders/components-link-placeholders.md b/migration-context/link-placeholders/components-link-placeholders.md deleted file mode 100644 index 442454fe..00000000 --- a/migration-context/link-placeholders/components-link-placeholders.md +++ /dev/null @@ -1,65 +0,0 @@ -# Link Placeholders for Components - -## reference_versioned_docs/version-v4/components/overview.md - -- Line (See Also section): `[TODO:reference_versioned_docs/version-v4/resources/resource-api.md]` - - Context: "See Also" section pointing to Resource API - - Target should be: `../resources/resource-api.md` - -- Line (See Also section): `[TODO:reference_versioned_docs/version-v4/database/schema.md]` - - Context: "See Also" section pointing to schema definition docs - - Target should be: `../database/schema.md` - -## reference_versioned_docs/version-v4/components/applications.md - -- Line (rest section): `[TODO:reference_versioned_docs/version-v4/rest/overview.md]` - - Context: Reference to REST interface documentation - - Target should be: `../rest/overview.md` - -- Line (graphqlSchema section): `[TODO:reference_versioned_docs/version-v4/database/schema.md]` - - Context: Reference to schema definition documentation - - Target should be: `../database/schema.md` - -- Line (jsResource section): `[TODO:reference_versioned_docs/version-v4/resources/resource-api.md]` - - Context: Reference to Resource API documentation - - Target should be: `../resources/resource-api.md` - -- Line (static section): `[TODO:reference_versioned_docs/version-v4/static-files/overview.md]` - - Context: Reference to static files documentation - - Target should be: `../static-files/overview.md` - -- Line (fastifyRoutes section): `[TODO:reference_versioned_docs/version-v4/fastify-routes/overview.md]` - - Context: Reference to Fastify routes documentation - - Target should be: `../fastify-routes/overview.md` - -- Line (graphql section): `[TODO:reference_versioned_docs/version-v4/graphql-querying/overview.md]` - - Context: Reference to GraphQL querying documentation - - Target should be: `../graphql-querying/overview.md` - -- Line (loadEnv section): `[TODO:reference_versioned_docs/version-v4/environment-variables/overview.md]` - - Context: Reference to environment variables documentation - - Target should be: `../environment-variables/overview.md` - -- Line (roles section): `[TODO:reference_versioned_docs/version-v4/users-and-roles/configuration.md]` - - Context: Reference to users and roles configuration - - Target should be: `../users-and-roles/configuration.md` - -- Line (dataLoader section): `[TODO:reference_versioned_docs/version-v4/database/data-loader.md]` - - Context: Reference to data loader documentation - - Target should be: `../database/data-loader.md` - -## reference_versioned_docs/version-v4/components/extension-api.md - -- Line (Protocol Extension section): `[TODO:reference_versioned_docs/version-v4/http/api.md]` - - Context: Reference to the `server` global API for custom networking - - Target should be: `../http/api.md` - -## reference_versioned_docs/version-v4/components/plugin-api.md - -- Line (`scope.resources`): `[TODO:reference_versioned_docs/version-v4/resources/resource-api.md]` - - Context: Reference to Resource class in scope.resources - - Target should be: `../resources/resource-api.md` - -- Line (`scope.server`): `[TODO:reference_versioned_docs/version-v4/http/api.md]` - - Context: Reference to HTTP server global API - - Target should be: `../http/api.md` diff --git a/migration-context/link-placeholders/configuration-link-placeholders.md b/migration-context/link-placeholders/configuration-link-placeholders.md deleted file mode 100644 index 113520bd..00000000 --- a/migration-context/link-placeholders/configuration-link-placeholders.md +++ /dev/null @@ -1,61 +0,0 @@ -# Link Placeholders for Configuration - -## reference_versioned_docs/version-v4/configuration/options.md - -- Line (http.mtls section): `[mTLS Authentication](TODO:reference_versioned_docs/version-v4/security/mtls-authentication.md)` - - Context: Referencing full mTLS authentication reference from HTTP mTLS config sub-section - - Target should be: `../security/mtls-authentication.md` - -- Line (http.mtls.certificateVerification): `[Certificate Verification](TODO:reference_versioned_docs/version-v4/security/certificate-verification.md)` - - Context: Referencing certificate revocation checking (CRL/OCSP) documentation - - Target should be: `../security/certificate-verification.md` - -- Line (tls section): `[TLS](TODO:reference_versioned_docs/version-v4/http/tls.md)` - - Context: Linking to TLS configuration reference in the HTTP section - - Target should be: `../http/tls.md` - -- Line (tls section): `[Certificate Management](TODO:reference_versioned_docs/version-v4/security/certificate-management.md)` - - Context: Linking to certificate management operations - - Target should be: `../security/certificate-management.md` - -- Line (mqtt section): `[MQTT Configuration](TODO:reference_versioned_docs/version-v4/mqtt/configuration.md)` - - Context: Referencing full MQTT configuration reference - - Target should be: `../mqtt/configuration.md` - -- Line (logging section): `[logger API](TODO:reference_versioned_docs/version-v4/logging/api.md)` - - Context: `logging.external` section referencing the logger API for components - - Target should be: `../logging/api.md` - -- Line (replication section): `[Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md)` - - Context: Referencing replication overview from replication config section - - Target should be: `../replication/overview.md` - -- Line (replication section): `[Clustering](TODO:reference_versioned_docs/version-v4/replication/clustering.md)` - - Context: Referencing clustering reference from replication config section - - Target should be: `../replication/clustering.md` - -- Line (replication.shard): `[Sharding](TODO:reference_versioned_docs/version-v4/replication/sharding.md)` - - Context: Referencing sharding documentation for `replication.shard` config option - - Target should be: `../replication/sharding.md` - -- Line (storage.compactOnStart): `[Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md)` - - Context: Referencing compaction documentation from `compactOnStart` storage option - - Target should be: `../database/compaction.md` - -- Line (localStudio section): `[Studio](TODO:reference_versioned_docs/version-v4/studio/overview.md)` - - Context: Referencing Studio overview from `localStudio` config section - - Target should be: `../studio/overview.md` - -- Line (Components section): `[Components](TODO:reference_versioned_docs/version-v4/components/overview.md)` - - Context: Referencing components overview from component config section - - Target should be: `../components/overview.md` - -## reference_versioned_docs/version-v4/configuration/operations.md - -- Line (set_configuration description): `[restart](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart)` - - Context: Linking to the restart system operation needed after set_configuration - - Target should be: `../operations-api/operations.md#restart` - -- Line (set_configuration description): `[restart_service](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart-service)` - - Context: Linking to the restart_service operation needed after set_configuration - - Target should be: `../operations-api/operations.md#restart-service` diff --git a/migration-context/link-placeholders/database-link-placeholders.md b/migration-context/link-placeholders/database-link-placeholders.md deleted file mode 100644 index 2d8a74f0..00000000 --- a/migration-context/link-placeholders/database-link-placeholders.md +++ /dev/null @@ -1,135 +0,0 @@ -# Link Placeholders for Database Section - -## reference_versioned_docs/version-v4/database/overview.md - -- Line ~37: `[Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md)` - - Context: Mentioning custom resources as extension of the database system - - Target should be: Resource API reference page - -- Line ~55: `[REST](TODO:reference_versioned_docs/version-v4/rest/overview.md)` - - Context: Related documentation footer - - Target should be: REST overview - -- Line ~56: `[Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md)` - - Context: Related documentation footer - - Target should be: Resources overview - -- Line ~57: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Related documentation footer - - Target should be: Operations API overview - -- Line ~58: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: Related documentation footer - - Target should be: Configuration overview - -## reference_versioned_docs/version-v4/database/schema.md - -- Line ~164: `[REST Querying](TODO:reference_versioned_docs/version-v4/rest/querying.md)` - - Context: How to query tables via HTTP using schema-defined relationships - - Target should be: REST querying reference - -- Line ~165: `[Resources](TODO:reference_versioned_docs/version-v4/resources/resource-api.md)` - - Context: Extending table behavior with custom resource logic - - Target should be: Resource API reference - -- Line ~167: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md)` - - Context: graphqlSchema component and storage configuration - - Target should be: Configuration options page - -- Line ~141 (Dynamic Schema section): `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/operations.md)` - - Context: NoSQL create_attribute/drop_attribute operations - - Target should be: Operations list page - -## reference_versioned_docs/version-v4/database/data-loader.md - -- Line ~13: `[Extension](TODO:reference_versioned_docs/version-v4/components/extension-api.md)` - - Context: dataLoader is an Extension component - - Target should be: Extension API reference - -- Line ~73: `[Components](TODO:reference_versioned_docs/version-v4/components/overview.md)` - - Context: Related documentation footer - - Target should be: Components overview - -## reference_versioned_docs/version-v4/database/storage-algorithm.md - -- Line ~45: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md)` - - Context: Storage configuration options (compression settings) - - Target should be: Configuration options page (storage section) - -## reference_versioned_docs/version-v4/database/jobs.md - -- Line ~128: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Related documentation footer - - Target should be: Operations API overview - -## reference_versioned_docs/version-v4/database/system-tables.md - -- Line ~82: `[Analytics](TODO:reference_versioned_docs/version-v4/analytics/overview.md)` - - Context: Full analytics metrics reference in related docs footer - - Target should be: Analytics overview - -- Line ~95: `[Replication](TODO:reference_versioned_docs/version-v4/replication/clustering.md)` - - Context: hdb_nodes used by clustering operations - - Target should be: Clustering reference - -- Line ~104: `[Analytics](TODO:reference_versioned_docs/version-v4/analytics/overview.md)` (second reference) - - Context: Related documentation footer - - Target should be: Analytics overview - -- Line ~105: `[Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md)` - - Context: Related documentation footer - - Target should be: Replication overview - -- Line ~106: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Querying system tables - - Target should be: Operations API overview - -## reference_versioned_docs/version-v4/database/compaction.md - -- Line ~38: `[CLI Commands](TODO:reference_versioned_docs/version-v4/cli/commands.md)` - - Context: copy-db CLI command - - Target should be: CLI commands reference - -- Line ~56: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md)` - - Context: Storage configuration options - - Target should be: Configuration options page (storage section) - -## reference_versioned_docs/version-v4/database/api.md - -- Line ~20: `[Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md)` - - Context: Noting that table classes implement the Resource API - - Target should be: Resource API reference page - -- Line ~48: `[Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md)` (second reference) - - Context: Pointing to full table method reference - - Target should be: Resource API reference page - -- Line ~186: `[Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md)` (Related Documentation) - - Context: Related docs footer - - Target should be: Resource API reference page - -- Line ~188: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md)` - - Context: Blob storage path configuration - - Target should be: Configuration options page (storage section) - -## reference_versioned_docs/version-v4/database/transaction.md - -- Line ~73: `[Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md)` - - Context: Clustering must be set up for transaction logs - - Target should be: Replication overview - -- Line ~148: `[Logging](TODO:reference_versioned_docs/version-v4/logging/overview.md)` - - Context: Distinction between app logging and transaction/audit logging - - Target should be: Logging overview - -- Line ~149: `[Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md)` (second reference) - - Context: Related documentation footer - - Target should be: Replication overview - -- Line ~150: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/options.md)` - - Context: logging.auditLog global configuration - - Target should be: Configuration options page - -- Line ~151: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Related documentation footer - - Target should be: Operations API overview diff --git a/migration-context/link-placeholders/environment-variables-link-placeholders.md b/migration-context/link-placeholders/environment-variables-link-placeholders.md deleted file mode 100644 index 8943b2ec..00000000 --- a/migration-context/link-placeholders/environment-variables-link-placeholders.md +++ /dev/null @@ -1,19 +0,0 @@ -# Link Placeholders for Environment Variables - -## reference_versioned_docs/version-v4/environment-variables/overview.md - -- Line 14: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: Intro list item — "Harper configuration via environment variables — see Configuration" - - Target should be: Configuration section overview page - -- Line 67: `[Resource Extension](TODO:reference_versioned_docs/version-v4/components/overview.md)` - - Context: Describing that `loadEnv` is a Resource Extension supporting standard `files`/`urlPath` config options - - Target should be: Components overview page (covering the Resource Extension concept) - -- Line 79: `[Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md)` - - Context: "Related" section - - Target should be: Main components/extensions reference page - -- Line 80: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: "Related" section — linking to where env var config details live - - Target should be: Configuration section overview page diff --git a/migration-context/link-placeholders/fastify-routes-link-placeholders.md b/migration-context/link-placeholders/fastify-routes-link-placeholders.md deleted file mode 100644 index 1abcd32f..00000000 --- a/migration-context/link-placeholders/fastify-routes-link-placeholders.md +++ /dev/null @@ -1,11 +0,0 @@ -# Link Placeholders for Fastify Routes - -## reference_versioned_docs/version-v4/fastify-routes/overview.md - -- Line 10: `[Custom Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md "Resources documentation")` - - Context: Explaining that Fastify routes are discouraged in favor of modern routing with Custom Resources - - Target should be: Resources overview page - -- Line 9: `[REST interface](TODO:reference_versioned_docs/version-v4/rest/overview.md "REST interface documentation")` - - Context: Recommending REST interface for better performance and standards compliance - - Target should be: REST overview page diff --git a/migration-context/link-placeholders/graphql-querying-link-placeholders.md b/migration-context/link-placeholders/graphql-querying-link-placeholders.md deleted file mode 100644 index 794837f6..00000000 --- a/migration-context/link-placeholders/graphql-querying-link-placeholders.md +++ /dev/null @@ -1,14 +0,0 @@ -# Link Placeholders for GraphQL Querying - -## reference_versioned_docs/version-v4/graphql-querying/overview.md - -- Line 17: `[defining schemas](TODO:reference_versioned_docs/version-v4/components/applications.md "Schema definition documentation")` - - Context: Introduction explaining GraphQL support for defining schemas - - Target should be: Schema definition documentation in Components/Applications section - - **Status**: PENDING (Components section migration) - -- ~~Line 17: `[Resources](./resources/overview.md)`~~ **FIXED** → `TODO:reference_versioned_docs/version-v4/resources/overview.md` (was a broken relative path — resources is a sibling section, not a subdirectory) - - **Status**: PENDING (Resources section migration) - -- ~~Line 58: `[Resource Query API](./resources/overview.md#query)`~~ **FIXED** → `TODO:reference_versioned_docs/version-v4/resources/overview.md#query` (was a broken relative path) - - **Status**: PENDING (Resources section migration) diff --git a/migration-context/link-placeholders/http-link-placeholders.md b/migration-context/link-placeholders/http-link-placeholders.md deleted file mode 100644 index 9227efd1..00000000 --- a/migration-context/link-placeholders/http-link-placeholders.md +++ /dev/null @@ -1,48 +0,0 @@ -# Link Placeholders for HTTP Section - -## reference_versioned_docs/version-v4/http/tls.md - -- Line (intro + body): `[Operations API Configuration](TODO:reference_versioned_docs/version-v4/configuration/operations.md)` - - Context: Noting that operationsApi.tls overrides the root tls section (appears twice) - - Target should be: Configuration section operations.md page - - **Status**: PENDING (Configuration section migration) - -- ~~Line (Related section): `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **NOTE**: Not present in file — Related section links to `../security/mtls-authentication.md` which was already resolved. - -## reference_versioned_docs/version-v4/http/overview.md - -- ~~Line (TLS section): `[Security](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **RESOLVED** → `../security/overview.md` -- ~~Line (Related section): `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **RESOLVED** → `../security/overview.md` - -- Line (Related section): `[REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md)` - - Context: Related reference for REST protocol - - Target should be: REST section overview page - - **Status**: PENDING (REST section migration) - -## reference_versioned_docs/version-v4/http/configuration.md - -- ~~Line (Related section): `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **RESOLVED** → `../security/overview.md` - -- Line (Related section): `[Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: Full configuration reference - - Target should be: Configuration section overview page - - **Status**: PENDING (Configuration section migration) - -## reference_versioned_docs/version-v4/http/api.md - -- ~~Line (server.recordAnalytics): `[analytics API](TODO:reference_versioned_docs/version-v4/analytics/overview.md)`~~ **RESOLVED** → `../analytics/overview.md` - -- Line (server.operation): `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Link to operations API overview - - Target should be: Operations API overview page - - **Status**: PENDING (Operations API section migration) - -- Line (Related section): `[REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md)` - - Context: Related reference for REST protocol - - Target should be: REST section overview page - - **Status**: PENDING (REST section migration) - -- Line (Related section): `[Global APIs](TODO:reference_versioned_docs/version-v4/resources/global-apis.md)` - - Context: Full global API reference including tables, databases, Resource, logger, auth - - Target should be: Resources global-apis page - - **Status**: PENDING (Resources section migration) diff --git a/migration-context/link-placeholders/logging-link-placeholders.md b/migration-context/link-placeholders/logging-link-placeholders.md deleted file mode 100644 index 9bd31e66..00000000 --- a/migration-context/link-placeholders/logging-link-placeholders.md +++ /dev/null @@ -1,34 +0,0 @@ -# Link Placeholders for Logging Section - -## reference_versioned_docs/version-v4/logging/overview.md - -- Line 14 + 62: `[Database / Transaction Logging](TODO:reference_versioned_docs/version-v4/database/transaction.md)` - - Context: Noting that audit logging and transaction logging are documented in the database section - - Target should be: Database transaction/audit logging page - - **Status**: PENDING (Database section migration) - -## reference_versioned_docs/version-v4/logging/configuration.md - -- Line 72 + 192: `[Database / Transaction Logging](TODO:reference_versioned_docs/version-v4/database/transaction.md)` - - Context: After describing logging.auditLog / related section - - Target should be: Database transaction/audit logging page - - **Status**: PENDING (Database section migration) - -- ~~Line 133: `[HTTP Configuration](TODO:reference_versioned_docs/version-v4/http/configuration.md)`~~ **RESOLVED** → `../http/configuration.md` - -- Line 193: `[Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: Related section — full config reference - - Target should be: Configuration section overview page - - **Status**: PENDING (Configuration section migration) - -## reference_versioned_docs/version-v4/logging/operations.md - -- Line 9 + 76: `[Database / Transaction Logging](TODO:reference_versioned_docs/version-v4/database/transaction.md)` - - Context: Callout + related section noting audit/transaction log operations are in the database section - - Target should be: Database transaction/audit logging page - - **Status**: PENDING (Database section migration) - -- Line 77: `[Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md)` - - Context: Related section — operations API overview - - Target should be: Operations API section overview page - - **Status**: PENDING (Operations API section migration) diff --git a/migration-context/link-placeholders/mqtt-link-placeholders.md b/migration-context/link-placeholders/mqtt-link-placeholders.md deleted file mode 100644 index 5c4a9e3a..00000000 --- a/migration-context/link-placeholders/mqtt-link-placeholders.md +++ /dev/null @@ -1,32 +0,0 @@ -# Link Placeholders for MQTT Section - -## reference_versioned_docs/version-v4/mqtt/overview.md - -- Line 28: `[schema.graphql](TODO:reference_versioned_docs/version-v4/database/schema.md)` - - Context: Explaining how to define a table that becomes an MQTT topic namespace - - Target should be: Schema definition reference page (database section) - - **Status**: PENDING (Database section migration) - -- ~~Line 101: `[HTTP Overview](TODO:reference_versioned_docs/version-v4/http/overview.md)`~~ **RESOLVED** → `../http/overview.md` -- ~~Line 103: `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **RESOLVED** → `../security/overview.md` - -- Line 104: `[Database Schema](TODO:reference_versioned_docs/version-v4/database/schema.md)` - - Context: Related section — defining tables/topics - - Target should be: Database schema reference page - - **Status**: PENDING (Database section migration) - -- Line 105: `[REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md)` - - Context: Related section — noting REST and MQTT share the same path conventions - - Target should be: REST section overview page - - **Status**: PENDING (REST section migration) - -## reference_versioned_docs/version-v4/mqtt/configuration.md - -- ~~Line 20: `[TLS Configuration](TODO:reference_versioned_docs/version-v4/http/tls.md)`~~ **RESOLVED** → `../http/tls.md` -- ~~Line 133: `[TLS Configuration](TODO:reference_versioned_docs/version-v4/http/tls.md)`~~ **RESOLVED** → `../http/tls.md` -- ~~Line 134: `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md)`~~ **RESOLVED** → `../security/overview.md` - -- Line 135: `[Configuration Overview](TODO:reference_versioned_docs/version-v4/configuration/overview.md)` - - Context: Related section — full harperdb-config.yaml reference - - Target should be: Configuration section overview page - - **Status**: PENDING (Configuration section migration) diff --git a/migration-context/link-placeholders/operations-api-link-placeholders.md b/migration-context/link-placeholders/operations-api-link-placeholders.md deleted file mode 100644 index fb679c8b..00000000 --- a/migration-context/link-placeholders/operations-api-link-placeholders.md +++ /dev/null @@ -1,131 +0,0 @@ -# Link Placeholders for Operations API - -## reference_versioned_docs/version-v4/operations-api/overview.md - -- Line 18: `[TODO:reference_versioned_docs/version-v4/configuration/overview.md]` - - Context: Describing how to change the Operations API port via configuration - - Target should be: Configuration overview page (operationsApi.network section) - -- Line 24: `[Basic Authentication](TODO:reference_versioned_docs/version-v4/security/basic-authentication.md)` - - Context: Listing supported authentication methods for Operations API - - Target should be: Basic authentication reference page - -- Line 25: `[JWT Authentication](TODO:reference_versioned_docs/version-v4/security/jwt-authentication.md)` - - Context: Listing supported authentication methods for Operations API - - Target should be: JWT authentication reference page - -- Line 41: `[Operations](./operations.md)` — **Internal link; already resolved** - -- Table row: `[Databases & Tables](./operations.md#databases--tables)` — **Internal link; already resolved** - -- Table row: `[NoSQL Operations](./operations.md#nosql-operations)` — **Internal link; already resolved** - -- Table row: `[Bulk Operations](./operations.md#bulk-operations)` — **Internal link; already resolved** - -- Table row: `[SQL Operations](./operations.md#sql-operations)` — **Internal link; already resolved** - -- Table row: `[Users & Roles](./operations.md#users--roles)` — **Internal link; already resolved** - -- Table row: `[Token Authentication](./operations.md#token-authentication)` — **Internal link; already resolved** - -- Table row: `[Components](./operations.md#components)` — **Internal link; already resolved** - -- Table row: `[Replication & Clustering](./operations.md#replication--clustering)` — **Internal link; already resolved** - -- Table row: `[Configuration](./operations.md#configuration)` — **Internal link; already resolved** - -- Table row: `[Jobs](./operations.md#jobs)` — **Internal link; already resolved** - -- Table row: `[Logs](./operations.md#logs)` — **Internal link; already resolved** - -- Table row: `[Certificate Management](./operations.md#certificate-management)` — **Internal link; already resolved** - -- Table row: `[Analytics](./operations.md#analytics)` — **Internal link; already resolved** - -- Table row: `[Registration & Licensing](./operations.md#registration--licensing)` — **Internal link; already resolved** - ---- - -## reference_versioned_docs/version-v4/operations-api/operations.md - -### Databases & Tables section - -- Line (Databases & Tables description): `[TODO:reference_versioned_docs/version-v4/database/overview.md]` - - Context: "Detailed documentation" link at top of Databases & Tables section - - Target should be: Database overview page - -### NoSQL Operations section - -- Line (NoSQL Operations description): `[TODO:reference_versioned_docs/version-v4/rest/querying.md]` - - Context: "Detailed documentation" link at top of NoSQL Operations section - - Target should be: REST querying reference (also covers NoSQL query patterns) - -### Bulk Operations section - -- Line (Bulk Operations description): `[TODO:reference_versioned_docs/version-v4/database/jobs.md]` - - Context: "Detailed documentation" link at top of Bulk Operations section - - Target should be: Database jobs reference page - -### SQL Operations section - -- Line (SQL Operations description): `[TODO:reference_versioned_docs/version-v4/legacy/sql]` - - Context: "Detailed documentation" link at top of SQL Operations section - - Target should be: Legacy SQL guide section - -### Users & Roles section - -- Two instances: `[TODO:reference_versioned_docs/version-v4/users-and-roles/operations.md]` - - Context: "Detailed documentation" link and inline "See" link in Users & Roles section - - Target should be: Users & Roles operations page - -### Token Authentication section - -- Line (Token Authentication description): `[TODO:reference_versioned_docs/version-v4/security/jwt-authentication.md]` - - Context: "Detailed documentation" link at top of Token Authentication section - - Target should be: JWT authentication reference page - -### Components section - -- Line (Components description): `[TODO:reference_versioned_docs/version-v4/components/overview.md]` - - Context: "Detailed documentation" link at top of Components section - - Target should be: Components overview page - -- Line (Deprecated Custom Functions): `[TODO:reference_versioned_docs/version-v4/components/overview.md]` - - Context: Referring readers from deprecated custom-functions ops to modern equivalent - - Target should be: Components overview page - -### Replication & Clustering section - -- Line (Replication description): `[TODO:reference_versioned_docs/version-v4/replication/clustering.md]` - - Context: "Detailed documentation" link at top of Replication & Clustering section - - Target should be: Replication clustering reference page - -### Configuration section - -- Two instances: `[TODO:reference_versioned_docs/version-v4/configuration/overview.md]` - - Context: "Detailed documentation" link at top of Configuration section and inline reference - - Target should be: Configuration overview page - -### Jobs section - -- Two instances: `[TODO:reference_versioned_docs/version-v4/database/jobs.md]` - - Context: "Detailed documentation" link at top of Jobs section and inline reference - - Target should be: Database jobs reference page - -### Logs section - -- Line (Logs description): `[TODO:reference_versioned_docs/version-v4/logging/operations.md]` - - Context: "Detailed documentation" link at top of Logs section - - Target should be: Logging operations page - -### Certificate Management section - -- Line (Certificate Management description): `[TODO:reference_versioned_docs/version-v4/security/certificate-management.md]` - - Context: "Detailed documentation" link at top of Certificate Management section - - Target should be: Security certificate management page - -### Analytics section - -- Line (Analytics description): `[TODO:reference_versioned_docs/version-v4/analytics/operations.md]` - - Context: "Detailed documentation" link at top of Analytics section - - Target should be: Analytics operations page diff --git a/migration-context/link-placeholders/replication-link-placeholders.md b/migration-context/link-placeholders/replication-link-placeholders.md deleted file mode 100644 index 1208c8a6..00000000 --- a/migration-context/link-placeholders/replication-link-placeholders.md +++ /dev/null @@ -1,11 +0,0 @@ -# Link Placeholders for Replication - -## reference_versioned_docs/version-v4/replication/overview.md - -- Line ~84: `[Certificate Verification](TODO:reference_versioned_docs/version-v4/security/certificate-verification.md)` - - Context: Describing certificate revocation checking for replication connections — links to the cert verification config page for OCSP/CRL settings - - Target should be: `../security/certificate-verification.md` - -- Line ~183: `[Certificate Management](TODO:reference_versioned_docs/version-v4/security/certificate-management.md)` - - Context: "See Also" section footer link - - Target should be: `../security/certificate-management.md` diff --git a/migration-context/link-placeholders/resources-link-placeholders.md b/migration-context/link-placeholders/resources-link-placeholders.md deleted file mode 100644 index 02f673ac..00000000 --- a/migration-context/link-placeholders/resources-link-placeholders.md +++ /dev/null @@ -1,21 +0,0 @@ -# Link Placeholders for Resources - -## reference_versioned_docs/version-v4/resources/overview.md - -- Line 27: `[REST Overview](TODO:reference_versioned_docs/version-v4/rest/overview.md)` - - Context: Explaining that the REST plugin maps HTTP requests to Resource methods - - Target should be: REST section overview page - -- Line 28: `[MQTT Overview](TODO:reference_versioned_docs/version-v4/mqtt/overview.md)` - - Context: Explaining that the MQTT plugin routes publish/subscribe to Resource methods - - Target should be: MQTT section overview page - -## reference_versioned_docs/version-v4/resources/resource-api.md - -No TODO placeholders — all cross-section links use relative paths for in-section links and section-relative paths otherwise. The global-apis.md has the external TODOs listed above. - -## reference_versioned_docs/version-v4/resources/query-optimization.md - -- Line 57: `[Schema documentation](TODO:reference_versioned_docs/version-v4/database/schema.md)` - - Context: Pointing to where relationship directives are defined in schemas - - Target should be: Database section schema page (not yet merged as of this PR) diff --git a/migration-context/link-placeholders/rest-link-placeholders.md b/migration-context/link-placeholders/rest-link-placeholders.md deleted file mode 100644 index 9d02b15b..00000000 --- a/migration-context/link-placeholders/rest-link-placeholders.md +++ /dev/null @@ -1,39 +0,0 @@ -# Link Placeholders for REST Section - -## reference_versioned_docs/version-v4/rest/overview.md - -- Line (See Also): `[Database / Schema](TODO:reference_versioned_docs/version-v4/database/schema.md 'Schema definition')` - - Context: Intro and See Also section — how to define and export resources - - Target should be: Database / Schema page - - **Status**: PENDING (Database section migration) - -## reference_versioned_docs/version-v4/rest/querying.md - -- Line (directURLMapping section): `[Database / Schema](TODO:reference_versioned_docs/version-v4/database/schema.md 'Schema and resource configuration')` - - Context: directURLMapping option reference - - Target should be: Database / Schema page - - **Status**: PENDING (Database section migration) - -- Line (See Also): `[Database / Schema](TODO:reference_versioned_docs/version-v4/database/schema.md 'Schema definition')` - - Context: See Also section - - Target should be: Database / Schema page - - **Status**: PENDING (Database section migration) - -## reference_versioned_docs/version-v4/rest/websockets.md - -- Line (Custom connect() Handler): `[Resource API](TODO:reference_versioned_docs/version-v4/resources/resource-api.md 'Resource API reference')` - - Context: Inline link for more on implementing custom resources - - Target should be: Resources / Resource API page - - **Status**: PENDING (Resources section migration) - -- Line (See Also): `[Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources overview')` - - Context: Link to custom resource API including `connect()` method - - Target should be: Resources section overview page - - **Status**: PENDING (Resources section migration) - -## reference_versioned_docs/version-v4/rest/server-sent-events.md - -- Line (See Also): `[Resources](TODO:reference_versioned_docs/version-v4/resources/overview.md 'Resources overview')` - - Context: Link to custom resource API including `connect()` method - - Target should be: Resources section overview page - - **Status**: PENDING (Resources section migration) diff --git a/migration-context/link-placeholders/security-link-placeholders.md b/migration-context/link-placeholders/security-link-placeholders.md deleted file mode 100644 index 2ba0604e..00000000 --- a/migration-context/link-placeholders/security-link-placeholders.md +++ /dev/null @@ -1,31 +0,0 @@ -# Link Placeholders for Security Section - -## reference_versioned_docs/version-v4/security/mtls-authentication.md - -- Line 47: `[TODO:reference_versioned_docs/version-v4/replication/clustering.md]` - - Context: Referring to replication mTLS configuration - - Target should be: Replication clustering page that covers mTLS for replication - -## reference_versioned_docs/version-v4/security/certificate-management.md - -- Line 8: `[TODO:reference_versioned_docs/version-v4/replication/clustering.md]` - - Context: Note that this page covers external-facing APIs; replication certs are covered separately - - Target should be: Replication clustering page with certificate management section - -- ~~Line 105: `[TODO:reference_versioned_docs/version-v4/cli/commands.md]`~~ **RESOLVED** → `../cli/commands.md` - -## reference_versioned_docs/version-v4/security/certificate-verification.md - -- Line 190: `[TODO:reference_versioned_docs/version-v4/replication/clustering.md]` - - Context: Replication mTLS configuration reference - - Target should be: Replication clustering page - -## reference_versioned_docs/version-v4/security/configuration.md - -- No pending TODO links. (`cors.md` and `ssl.md` were consolidated into this file; their cross-section links were resolved during initial migration.) - -## reference_versioned_docs/version-v4/security/overview.md - -- ~~`./users-and-roles.md`~~ **FIXED** → `../users-and-roles/overview.md` (users-and-roles is now a top-level section, not a file within security/) -- `TODO:reference_versioned_docs/version-v4/configuration/operations.md#network` — PENDING (Configuration section migration) -- `TODO:reference_versioned_docs/version-v4/configuration/operations.md#tls` — PENDING (Configuration section migration) diff --git a/migration-context/link-placeholders/static-files-link-placeholders.md b/migration-context/link-placeholders/static-files-link-placeholders.md deleted file mode 100644 index 9bbb31bf..00000000 --- a/migration-context/link-placeholders/static-files-link-placeholders.md +++ /dev/null @@ -1,15 +0,0 @@ -# Link Placeholders for Static Files - -## reference_versioned_docs/version-v4/static-files/overview.md - -- Line 41: `[Plugin](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview')` - - Context: Describing that `static` is a Plugin supporting standard `files`/`urlPath` config options - - Target should be: Components overview page (covering the Plugin concept and standard options) - -- Line 46: `[Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview — files and urlPath options')` - - Context: Directing the reader to full `files` glob pattern and `urlPath` documentation - - Target should be: Components overview page - -- Line 114: `[Components Overview](TODO:reference_versioned_docs/version-v4/components/overview.md 'Components, Applications, and Plugins overview — including files/urlPath options')` - - Context: "Related" section - - Target should be: Main components/plugins reference page diff --git a/migration-context/link-placeholders/studio-link-placeholders.md b/migration-context/link-placeholders/studio-link-placeholders.md deleted file mode 100644 index 9f262e1b..00000000 --- a/migration-context/link-placeholders/studio-link-placeholders.md +++ /dev/null @@ -1,11 +0,0 @@ -# Link Placeholders for Studio - -## reference_versioned_docs/version-v4/studio/overview.md - -- Line 20: `[configuration file](TODO:reference_versioned_docs/version-v4/configuration/options.md#localstudio "Configuration options")` - - Context: Explaining how to enable local Studio via configuration - - Target should be: Configuration options page localStudio section - - **Status**: PENDING (Configuration section migration) - -- ~~Line 27: `[Operations API](TODO:reference_versioned_docs/version-v4/operations/configuration.md)`~~ **FIXED path** → `TODO:reference_versioned_docs/version-v4/operations-api/overview.md` (was wrong path — `operations` → `operations-api`) - - **Status**: PENDING (Operations API section migration) From 9252961a7f134990be3eaa1704ec1087aa449010 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 09:19:05 -0600 Subject: [PATCH 10/13] =?UTF-8?q?chore:=20update=20MEMORY.md=20=E2=80=94?= =?UTF-8?q?=20Part=203=20link=20resolution=20complete?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Sonnet 4.6 --- memory/MEMORY.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 memory/MEMORY.md diff --git a/memory/MEMORY.md b/memory/MEMORY.md new file mode 100644 index 00000000..6c871872 --- /dev/null +++ b/memory/MEMORY.md @@ -0,0 +1,69 @@ +# Documentation Migration Memory + +## Project Overview + +Harper v4 docs migration: consolidating `versioned_docs/version-4.X/` → `reference_versioned_docs/version-v4/` with feature-based reorganization. + +- **Working branch**: `major-version-reorg` (all migration PRs target this branch) +- **Target dir**: `reference_versioned_docs/version-v4/` +- **Do NOT touch**: `versioned_docs/` or `reference/` + +## Key Files + +- `v4-docs-implementation-plan.md` — Agent instructions (follow Part 1 closely) +- `v4-docs-migration-map.md` — Authoritative source-to-target mapping per section +- `v4-docs-reference-plan.md` — Structure philosophy and outline +- `reference_versioned_sidebars/version-v4-sidebars.json` — Sidebar to update for each section +- ~~`migration-context/link-placeholders/`~~ — **Deleted** (Part 3 link resolution complete) + +## Release Notes Location + +`release-notes/v4-tucker/4.X.0.md` (NOT `release_notes/`) + +## Completed Sections + +All Phase 1A–1D sections are complete and merged: + +- CLI, GraphQL Querying, Studio, Fastify Routes (Phase 1A) +- Environment Variables, Static Files, HTTP, MQTT, Logging, Analytics (Phase 1B) +- Security, Users & Roles, REST (PR #457), Database (PR #458), Resources (PR #459), Components (PR #460), Replication (PR #461) (Phase 1C) +- Operations API (PR #462), Configuration (PR #463) (Phase 1D) + +## Key Decisions / Learnings + +- Each section gets its own branch `migration/[section-name]` off `major-version-reorg` +- PRs are draft by default, opened against `major-version-reorg` +- `@relationship` in v4.7 source (not `@relation` from 4.3 release notes) — needs human verification +- Audit log required for real-time messaging (MQTT/WebSocket) — verify still true +- `schema.md` kept unified (overview + blobs + vectors); consider splitting if too long +- System tables include: `hdb_raw_analytics`, `hdb_analytics`, `hdb_dataloader_hash`, `hdb_nodes`, `hdb_certificate` +- Analytics detail lives in `analytics/overview.md`, not `database/system-tables.md` +- Components section added `javascript-environment.md` (not in original plan) + +## Next Steps + +**Part 3 (Link Resolution) — Complete** on `link-resolution` branch (9 commits). Merge to `major-version-reorg` then continue with Part 4 (cross-references in release notes / learn guides) and Part 5 (redirects). + +### Part 3 Key Decisions + +- Operations table category links (e.g. `../operations-api/database.md`) → `../operations-api/operations.md` with section anchors (no sub-pages exist) +- `resources/global-apis.md` never created → links redirected to `../components/javascript-environment.md` +- SQL operations link → `../database/sql.md` (SQL moved from legacy per migration map) +- `[Applications](TODO:applications/overview.md)` → `../components/overview.md` +- Malformed `[TODO:path](TODO:path)` links in `components/overview.md` fixed with proper text + +Legacy section: single files only (no subfolders): `cloud.md`, `custom-functions.md`. SQL moved to `database/sql.md`. + +## Sidebar Pattern + +```json +{ + "type": "category", + "label": "Section Name", + "collapsible": false, + "className": "learn-category-header", + "items": [{ "type": "doc", "id": "section/page", "label": "Label" }] +} +``` + +Insert new sections before the Legacy category at the bottom of the sidebar. From e485b5fc2728db38a8278d6eabd82fb1db672fef Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 15:15:36 -0600 Subject: [PATCH 11/13] fix(reference): resolve broken anchors in reference/v4 docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - security/overview: remove non-existent #network and #tls anchors from configuration/operations links - replication/overview: remove non-existent #operations-api anchor from clustering link - http/overview: fix server.http() anchor (#serverhttp → #serverhttplistener-options) - logging/api: fix logging.external anchor (#logging-external → #loggingexternal) - configuration/operations: fix restart_service anchor (#restart-service → #restart_service) - graphql-querying/overview: fix Resource Query API link (resources/overview#query → rest/querying) - components/applications: fix add_ssh_key anchor (#add-ssh-key → #add_ssh_key) - components/plugin-api: add explicit {#scopehandleentry} id to handleEntry heading - resources/overview: fix empty database/schema link Co-Authored-By: Claude Sonnet 4.6 --- .../version-v4/components/applications.md | 2 +- reference_versioned_docs/version-v4/components/plugin-api.md | 2 +- .../version-v4/configuration/operations.md | 2 +- .../version-v4/graphql-querying/overview.md | 2 +- reference_versioned_docs/version-v4/http/overview.md | 2 +- reference_versioned_docs/version-v4/logging/api.md | 2 +- reference_versioned_docs/version-v4/replication/overview.md | 2 +- reference_versioned_docs/version-v4/resources/overview.md | 2 +- reference_versioned_docs/version-v4/security/overview.md | 4 ++-- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/reference_versioned_docs/version-v4/components/applications.md b/reference_versioned_docs/version-v4/components/applications.md index fb0185a4..5df64215 100644 --- a/reference_versioned_docs/version-v4/components/applications.md +++ b/reference_versioned_docs/version-v4/components/applications.md @@ -112,7 +112,7 @@ HarperDB/application-template#semver:v1.0.0 Harper generates a `package.json` from component configurations and uses a form of `npm install` to resolve them. This is why specifying a local file path creates a symlink (changes are picked up between restarts without redeploying). -For SSH-based private repos, use the [Add SSH Key](#add-ssh-key) operation to register keys first. +For SSH-based private repos, use the [Add SSH Key](#add_ssh_key) operation to register keys first. ## Dependency Management diff --git a/reference_versioned_docs/version-v4/components/plugin-api.md b/reference_versioned_docs/version-v4/components/plugin-api.md index 750c8a8e..c92cf839 100644 --- a/reference_versioned_docs/version-v4/components/plugin-api.md +++ b/reference_versioned_docs/version-v4/components/plugin-api.md @@ -120,7 +120,7 @@ The central object passed to `handleApplication()`. Provides access to configura - **`'error'`** — `error: unknown` — An error occurred - **`'ready'`** — Emitted when the Scope is ready after loading the config file -#### `scope.handleEntry([files][, handler])` +#### `scope.handleEntry([files][, handler])` {#scopehandleentry} Returns an [`EntryHandler`](#class-entryhandler) for watching and processing file system entries. diff --git a/reference_versioned_docs/version-v4/configuration/operations.md b/reference_versioned_docs/version-v4/configuration/operations.md index c6056ef1..109bb8c5 100644 --- a/reference_versioned_docs/version-v4/configuration/operations.md +++ b/reference_versioned_docs/version-v4/configuration/operations.md @@ -16,7 +16,7 @@ For the full list of configurable options, see [Configuration Options](./options ## Set Configuration -Modifies one or more Harper configuration parameters. **Requires a [restart](../operations-api/operations.md#restart) or [restart_service](../operations-api/operations.md#restart-service) to take effect.** +Modifies one or more Harper configuration parameters. **Requires a [restart](../operations-api/operations.md#restart) or [restart_service](../operations-api/operations.md#restart_service) to take effect.** `operation` _(required)_ — must be `set_configuration` diff --git a/reference_versioned_docs/version-v4/graphql-querying/overview.md b/reference_versioned_docs/version-v4/graphql-querying/overview.md index 625281bc..917f0e54 100644 --- a/reference_versioned_docs/version-v4/graphql-querying/overview.md +++ b/reference_versioned_docs/version-v4/graphql-querying/overview.md @@ -56,7 +56,7 @@ Accept: application/graphql-response+json > Tip: For the best user experience, include the `Accept: application/graphql-response+json` header in your request. This provides better status codes for errors. -The Harper GraphQL querying system is strictly limited to exported Harper Resources. This will typically be a table that uses the `@exported` directive in its schema or `export`'ed custom resources. Queries can only specify Harper Resources and their attributes in the selection set. Queries can filter using [arguments](https://graphql.org/learn/queries/#arguments) on the top-level Resource field. Harper provides a short form pattern for simple queries, and a long form pattern based off of the [Resource Query API](../resources/overview.md#query) for more complex queries. +The Harper GraphQL querying system is strictly limited to exported Harper Resources. This will typically be a table that uses the `@exported` directive in its schema or `export`'ed custom resources. Queries can only specify Harper Resources and their attributes in the selection set. Queries can filter using [arguments](https://graphql.org/learn/queries/#arguments) on the top-level Resource field. Harper provides a short form pattern for simple queries, and a long form pattern based off of the [Resource Query API](../rest/querying.md) for more complex queries. Unlike REST queries, GraphQL queries can specify multiple resources simultaneously: diff --git a/reference_versioned_docs/version-v4/http/overview.md b/reference_versioned_docs/version-v4/http/overview.md index 6199689f..06858a8c 100644 --- a/reference_versioned_docs/version-v4/http/overview.md +++ b/reference_versioned_docs/version-v4/http/overview.md @@ -22,7 +22,7 @@ In previous versions: Session-affinity based socket delegation was used to route ## Request Handling -Harper uses a layered middleware chain for HTTP request processing. Components and applications can add handlers to this chain using the [`server.http()`](./api#serverhttp) API. Handlers are called in order; each handler can either process the request and return a `Response`, or pass it along to the next handler with `next(request)`. +Harper uses a layered middleware chain for HTTP request processing. Components and applications can add handlers to this chain using the [`server.http()`](./api#serverhttplistener-options) API. Handlers are called in order; each handler can either process the request and return a `Response`, or pass it along to the next handler with `next(request)`. Request and response objects follow the [WHATWG Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) conventions (`Request` and `Response` classes), providing good composability for layered middleware and clean mapping to REST resource handlers. diff --git a/reference_versioned_docs/version-v4/logging/api.md b/reference_versioned_docs/version-v4/logging/api.md index afcda71e..68083591 100644 --- a/reference_versioned_docs/version-v4/logging/api.md +++ b/reference_versioned_docs/version-v4/logging/api.md @@ -9,7 +9,7 @@ title: Logging API ## `logger` -The `logger` global is available in all JavaScript components without any imports. It writes structured log entries to the standard Harper log file (`hdb.log`) at the configured `logging.external` level and path. See [Logging Configuration](./configuration#logging-external) for per-component log configuration. +The `logger` global is available in all JavaScript components without any imports. It writes structured log entries to the standard Harper log file (`hdb.log`) at the configured `logging.external` level and path. See [Logging Configuration](./configuration#loggingexternal) for per-component log configuration. The `logger` global is a `MainLogger`. Calling `logger.withTag(tag)` returns a `TaggedLogger` scoped to that tag. diff --git a/reference_versioned_docs/version-v4/replication/overview.md b/reference_versioned_docs/version-v4/replication/overview.md index c89a38f1..7847ecc9 100644 --- a/reference_versioned_docs/version-v4/replication/overview.md +++ b/reference_versioned_docs/version-v4/replication/overview.md @@ -45,7 +45,7 @@ replication: securePort: 9933 ``` -You can also manage nodes dynamically through the [Operations API](./clustering.md#operations-api) without editing the config file. +You can also manage nodes dynamically through the [Operations API](./clustering.md) without editing the config file. ### Gossip Discovery diff --git a/reference_versioned_docs/version-v4/resources/overview.md b/reference_versioned_docs/version-v4/resources/overview.md index 1530192b..09f47e5b 100644 --- a/reference_versioned_docs/version-v4/resources/overview.md +++ b/reference_versioned_docs/version-v4/resources/overview.md @@ -48,7 +48,7 @@ type MyTable @table { } ``` -> For more info on the schema API see [`Database / Schema`]() +> For more info on the schema API see [`Database / Schema`](../database/schema.md) Then, in a `resources.js` extend from the `tables.MyTable` global: diff --git a/reference_versioned_docs/version-v4/security/overview.md b/reference_versioned_docs/version-v4/security/overview.md index 8cc9a671..e6abc3d8 100644 --- a/reference_versioned_docs/version-v4/security/overview.md +++ b/reference_versioned_docs/version-v4/security/overview.md @@ -35,10 +35,10 @@ Harper supports three authentication methods: - CORS — Cross-Origin Resource Sharing. - For HTTP server configuration see [HTTP / Configuration / CORS](../http/configuration.md#cors) - - For Operations API configuration see [Operations API / Configuration / Network](../configuration/operations.md#network) + - For Operations API configuration see [Operations API / Configuration](../configuration/operations.md) - SSL & HTTPS — Enabling HTTPS and configuring TLS for the HTTP server. - For HTTP server configuration see [HTTP / Configuration / TLS](../http/tls.md) - - For Operations API configuration see [Operations API / Configuration / TLS](../configuration/operations.md#tls) + - For Operations API configuration see [Operations API / Configuration](../configuration/operations.md) - [Users and Roles](../users-and-roles/overview.md) — Role-Based Access Control (RBAC): defining roles, assigning permissions, and managing users. ## API From b279705b49ac8bf833ac9842b0ee269d4a9dff83 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 15:16:01 -0600 Subject: [PATCH 12/13] update memory docs --- memory/MEMORY.md | 11 +++- memory/part4-plan.md | 132 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 141 insertions(+), 2 deletions(-) create mode 100644 memory/part4-plan.md diff --git a/memory/MEMORY.md b/memory/MEMORY.md index 6c871872..d6647d17 100644 --- a/memory/MEMORY.md +++ b/memory/MEMORY.md @@ -31,7 +31,7 @@ All Phase 1A–1D sections are complete and merged: ## Key Decisions / Learnings -- Each section gets its own branch `migration/[section-name]` off `major-version-reorg` +- Each section gets its own branch `migration/[section-name]` off `major-version-reorg` (for phase 1 content generation) - PRs are draft by default, opened against `major-version-reorg` - `@relationship` in v4.7 source (not `@relation` from 4.3 release notes) — needs human verification - Audit log required for real-time messaging (MQTT/WebSocket) — verify still true @@ -42,7 +42,14 @@ All Phase 1A–1D sections are complete and merged: ## Next Steps -**Part 3 (Link Resolution) — Complete** on `link-resolution` branch (9 commits). Merge to `major-version-reorg` then continue with Part 4 (cross-references in release notes / learn guides) and Part 5 (redirects). +**Part 3 (Link Resolution) — Complete** on `link-resolution` branch (10 commits). Merge to `major-version-reorg` via PR review, then continue: + +**Part 4 (Cross-Reference Updates)** — Full plan in [`memory/part4-plan.md`](part4-plan.md). +- Branch: `cross-reference-updates` off `major-version-reorg` +- Scope: ~7 release note files + 1 learn guide with old `/docs/` links +- **First step**: verify URL prefix for new reference pages (check `docusaurus.config.js`) + +**Part 5 (Redirects)** — Configure redirects from old paths (`/docs/reference/`, `/docs/developers/`, etc.) to new paths in `docusaurus.config.js`. ### Part 3 Key Decisions diff --git a/memory/part4-plan.md b/memory/part4-plan.md new file mode 100644 index 00000000..7164ff10 --- /dev/null +++ b/memory/part4-plan.md @@ -0,0 +1,132 @@ +# Part 4: Cross-Reference Updates — Plan & Procedure + +## Overview + +Update links in `release-notes/` and `learn/` that point to old doc paths, mapping them to the new `reference_versioned_docs/version-v4/` structure. + +**Branch**: Create a new branch `cross-reference-updates` off `major-version-reorg` (after `link-resolution` is merged). + +**Commit strategy**: One commit per file group (release notes in one commit, learn guides in another, or broken down further if large). + +--- + +## Scope of Changes + +### Release Notes (`release-notes/v4-tucker/`) + +171 files total. Only ~7 files have `/docs/` links that need updating. The full list of unique links found (grep: `(/docs/[^)"\ ]*)` across all `release-notes/v4-tucker/*.md`): + +| Old Path | New Path | Notes | +|----------|----------|-------| +| `/docs/deployments/configuration` | `/docs/v4/configuration/overview` | 7 occurrences | +| `/docs/reference/resources` | `/docs/v4/resources/overview` | 4 occurrences | +| `/docs/developers/applications/defining-schemas` | `/docs/v4/database/schema` | 4 occurrences | +| `/docs/reference/graphql` | `/docs/v4/graphql-querying/overview` | 1 occurrence | +| `/docs/reference/components/extensions` | `/docs/v4/components/extension-api` | 1 occurrence | +| `/docs/reference/components/applications?_highlight=github#adding-components-to-root` | `/docs/v4/components/applications#adding-components-to-root` | 1 occurrence | +| `/docs/reference/blob` | `/docs/v4/database/schema#blob-storage` | 1 occurrence | +| `/docs/developers/rest` | `/docs/v4/rest/overview` | 1 occurrence | +| `/docs/developers/replication/sharding` | `/docs/v4/replication/sharding` | 1 occurrence | +| `/docs/developers/replication/` | `/docs/v4/replication/overview` | 1 occurrence | +| `/docs/developers/real-time` | `/docs/v4/rest/websockets` | 1 occurrence (real-time = websockets+SSE+MQTT) | +| `/docs/developers/operations-api/clustering` | `/docs/v4/replication/clustering` | 1 occurrence | +| `/docs/developers/applications/data-loader` | `/docs/v4/database/data-loader` | 1 occurrence | +| `/docs/deployments/harper-cli` | `/docs/v4/cli/overview` | 1 occurrence | +| `/docs/administration/logging/` | `/docs/v4/logging/overview` | 1 occurrence | +| `/docs/administration/cloning` | N/A — learn guide (not in reference) | Leave or link to learn guide if exists | +| `/docs/4.1/custom-functions/host-static` | `/docs/v4/legacy/custom-functions` | Legacy redirect | +| `/docs/4.1/configuration#storage` | `/docs/v4/configuration/options#storage` | 1 occurrence | +| `/docs/4.1/configuration#session-affinity` | `/docs/v4/configuration/options#http` | 1 occurrence (http section covers session affinity) | +| `/docs/4.1/configuration#schemas` | `/docs/v4/database/schema` | 1 occurrence | + +> **NOTE**: The exact URL prefix for the new structure (`/docs/v4/`) needs to be verified. Check `docusaurus.config.js` or `reference_versioned_sidebars/version-v4-sidebars.json` for the versioned path prefix. It may be `/docs/v4/` or `/reference/v4/` or similar. + +**Files that contain links (to edit):** +- `release-notes/v4-tucker/4.1.0.md` — `/docs/4.1/configuration#*` and `/docs/4.1/custom-functions/*` +- `release-notes/v4-tucker/4.2.0.md` — `/docs/reference/resources`, `/docs/reference/components/*` +- `release-notes/v4-tucker/4.3.0.md` — `/docs/reference/resources` +- `release-notes/v4-tucker/4.4.0.md` — `/docs/developers/applications/defining-schemas`, `/docs/reference/resources`, `/docs/reference/graphql` +- `release-notes/v4-tucker/4.5.0.md` — `/docs/reference/blob`, `/docs/deployments/configuration` + +**To find all affected files precisely**: `grep -rl "/docs/" release-notes/v4-tucker/` + +--- + +### Learn Guides (`learn/`) + +Only 4 content files currently exist (most are stubs): +- `learn/developers/harper-applications-in-depth.mdx` +- `learn/getting-started/create-your-first-application.mdx` +- `learn/getting-started/install-and-connect-harper.mdx` +- `learn/index.mdx` + +Links found in `harper-applications-in-depth.mdx`: + +| Old Path | New Path | +|----------|----------| +| `/docs/reference/components/built-in-extensions` | `/docs/v4/components/overview#built-in-extensions-reference` | +| `/docs/reference/resources` | `/docs/v4/resources/overview` | +| `/docs/reference/globals#logger` | `/docs/v4/logging/api` | +| `/docs/reference/resources/` | `/docs/v4/resources/overview` | +| `/docs/reference/components/` | `/docs/v4/components/overview` | + +--- + +## Procedure + +### Step 1: Verify URL prefix +Before editing any links, confirm what the new URL prefix is for `reference_versioned_docs/version-v4/`. Check: +```bash +cat docusaurus.config.js | grep -A5 "reference_versioned" +# or +cat reference_versioned_sidebars/version-v4-sidebars.json | head -5 +``` +The prefix is likely `/docs/v4/` but confirm before proceeding. + +### Step 2: Find all affected release note files +```bash +grep -rl "/docs/" release-notes/v4-tucker/ +``` +This gives the exact list of files to edit. + +### Step 3: Edit release notes +For each affected file, replace old `/docs/` paths with new `/docs/v4/` paths per the mapping table above. + +### Step 4: Edit learn guides +Read each of the 4 learn guide files, apply the mapping table above. + +### Step 5: Check for any remaining old-path links across the whole repo +```bash +grep -rn "/docs/reference/" --include="*.md" --include="*.mdx" release-notes/ learn/ +grep -rn "/docs/developers/" --include="*.md" --include="*.mdx" release-notes/ learn/ +grep -rn "/docs/deployments/" --include="*.md" --include="*.mdx" release-notes/ learn/ +grep -rn "/docs/administration/" --include="*.md" --include="*.mdx" release-notes/ learn/ +grep -rn "/docs/4\." --include="*.md" --include="*.mdx" release-notes/ learn/ +``` + +### Step 6: Commit +- Commit release notes changes: `docs(cross-refs): update old /docs/ links in release notes to v4 reference paths` +- Commit learn guide changes: `docs(cross-refs): update old /docs/ links in learn guides to v4 reference paths` + +--- + +## Key Uncertainties to Resolve + +1. **URL prefix** — Confirm whether new reference pages are served at `/docs/v4/`, `/reference/v4/`, or another prefix. **Critical before editing any links.** +2. **`/docs/administration/cloning`** — This was flagged in migration map as "move to Learn guide." If no learn guide exists yet, either leave as-is (broken link) or remove the link text. +3. **`/docs/developers/real-time`** — This page covered WebSockets, SSE, and MQTT. Best split into: WebSockets content → `rest/websockets`, MQTT content → `mqtt/overview`. In context of release notes, pick whichever is most relevant to the surrounding text. + +--- + +## Non-Goals for Part 4 + +- Do NOT edit `versioned_docs/` files +- Do NOT edit `reference_versioned_docs/` files (those were handled in Part 3) +- Do NOT update links in the v1/v2/v3 release notes (out of scope) +- Do NOT update links in other config files (docusaurus.config.js, sidebars, etc.) — that's Part 5 + +--- + +## After Part 4 + +Proceed to **Part 5: Redirects** — configure redirects from old `/docs/developers/`, `/docs/reference/`, etc. paths to the new `/docs/v4/` equivalents in `docusaurus.config.js` (or wherever redirects are configured). From cc872ca35917f66b9d357773c920a0ba02b5208b Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Mon, 30 Mar 2026 15:17:08 -0600 Subject: [PATCH 13/13] format --- memory/MEMORY.md | 1 + memory/part4-plan.md | 67 ++++---- .../version-v4/analytics/operations.md | 14 +- .../version-v4/cli/operations-api-commands.md | 144 +++++++++--------- 4 files changed, 119 insertions(+), 107 deletions(-) diff --git a/memory/MEMORY.md b/memory/MEMORY.md index d6647d17..e4dd2858 100644 --- a/memory/MEMORY.md +++ b/memory/MEMORY.md @@ -45,6 +45,7 @@ All Phase 1A–1D sections are complete and merged: **Part 3 (Link Resolution) — Complete** on `link-resolution` branch (10 commits). Merge to `major-version-reorg` via PR review, then continue: **Part 4 (Cross-Reference Updates)** — Full plan in [`memory/part4-plan.md`](part4-plan.md). + - Branch: `cross-reference-updates` off `major-version-reorg` - Scope: ~7 release note files + 1 learn guide with old `/docs/` links - **First step**: verify URL prefix for new reference pages (check `docusaurus.config.js`) diff --git a/memory/part4-plan.md b/memory/part4-plan.md index 7164ff10..1d243338 100644 --- a/memory/part4-plan.md +++ b/memory/part4-plan.md @@ -16,32 +16,33 @@ Update links in `release-notes/` and `learn/` that point to old doc paths, mappi 171 files total. Only ~7 files have `/docs/` links that need updating. The full list of unique links found (grep: `(/docs/[^)"\ ]*)` across all `release-notes/v4-tucker/*.md`): -| Old Path | New Path | Notes | -|----------|----------|-------| -| `/docs/deployments/configuration` | `/docs/v4/configuration/overview` | 7 occurrences | -| `/docs/reference/resources` | `/docs/v4/resources/overview` | 4 occurrences | -| `/docs/developers/applications/defining-schemas` | `/docs/v4/database/schema` | 4 occurrences | -| `/docs/reference/graphql` | `/docs/v4/graphql-querying/overview` | 1 occurrence | -| `/docs/reference/components/extensions` | `/docs/v4/components/extension-api` | 1 occurrence | -| `/docs/reference/components/applications?_highlight=github#adding-components-to-root` | `/docs/v4/components/applications#adding-components-to-root` | 1 occurrence | -| `/docs/reference/blob` | `/docs/v4/database/schema#blob-storage` | 1 occurrence | -| `/docs/developers/rest` | `/docs/v4/rest/overview` | 1 occurrence | -| `/docs/developers/replication/sharding` | `/docs/v4/replication/sharding` | 1 occurrence | -| `/docs/developers/replication/` | `/docs/v4/replication/overview` | 1 occurrence | -| `/docs/developers/real-time` | `/docs/v4/rest/websockets` | 1 occurrence (real-time = websockets+SSE+MQTT) | -| `/docs/developers/operations-api/clustering` | `/docs/v4/replication/clustering` | 1 occurrence | -| `/docs/developers/applications/data-loader` | `/docs/v4/database/data-loader` | 1 occurrence | -| `/docs/deployments/harper-cli` | `/docs/v4/cli/overview` | 1 occurrence | -| `/docs/administration/logging/` | `/docs/v4/logging/overview` | 1 occurrence | -| `/docs/administration/cloning` | N/A — learn guide (not in reference) | Leave or link to learn guide if exists | -| `/docs/4.1/custom-functions/host-static` | `/docs/v4/legacy/custom-functions` | Legacy redirect | -| `/docs/4.1/configuration#storage` | `/docs/v4/configuration/options#storage` | 1 occurrence | -| `/docs/4.1/configuration#session-affinity` | `/docs/v4/configuration/options#http` | 1 occurrence (http section covers session affinity) | -| `/docs/4.1/configuration#schemas` | `/docs/v4/database/schema` | 1 occurrence | +| Old Path | New Path | Notes | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------- | +| `/docs/deployments/configuration` | `/docs/v4/configuration/overview` | 7 occurrences | +| `/docs/reference/resources` | `/docs/v4/resources/overview` | 4 occurrences | +| `/docs/developers/applications/defining-schemas` | `/docs/v4/database/schema` | 4 occurrences | +| `/docs/reference/graphql` | `/docs/v4/graphql-querying/overview` | 1 occurrence | +| `/docs/reference/components/extensions` | `/docs/v4/components/extension-api` | 1 occurrence | +| `/docs/reference/components/applications?_highlight=github#adding-components-to-root` | `/docs/v4/components/applications#adding-components-to-root` | 1 occurrence | +| `/docs/reference/blob` | `/docs/v4/database/schema#blob-storage` | 1 occurrence | +| `/docs/developers/rest` | `/docs/v4/rest/overview` | 1 occurrence | +| `/docs/developers/replication/sharding` | `/docs/v4/replication/sharding` | 1 occurrence | +| `/docs/developers/replication/` | `/docs/v4/replication/overview` | 1 occurrence | +| `/docs/developers/real-time` | `/docs/v4/rest/websockets` | 1 occurrence (real-time = websockets+SSE+MQTT) | +| `/docs/developers/operations-api/clustering` | `/docs/v4/replication/clustering` | 1 occurrence | +| `/docs/developers/applications/data-loader` | `/docs/v4/database/data-loader` | 1 occurrence | +| `/docs/deployments/harper-cli` | `/docs/v4/cli/overview` | 1 occurrence | +| `/docs/administration/logging/` | `/docs/v4/logging/overview` | 1 occurrence | +| `/docs/administration/cloning` | N/A — learn guide (not in reference) | Leave or link to learn guide if exists | +| `/docs/4.1/custom-functions/host-static` | `/docs/v4/legacy/custom-functions` | Legacy redirect | +| `/docs/4.1/configuration#storage` | `/docs/v4/configuration/options#storage` | 1 occurrence | +| `/docs/4.1/configuration#session-affinity` | `/docs/v4/configuration/options#http` | 1 occurrence (http section covers session affinity) | +| `/docs/4.1/configuration#schemas` | `/docs/v4/database/schema` | 1 occurrence | > **NOTE**: The exact URL prefix for the new structure (`/docs/v4/`) needs to be verified. Check `docusaurus.config.js` or `reference_versioned_sidebars/version-v4-sidebars.json` for the versioned path prefix. It may be `/docs/v4/` or `/reference/v4/` or similar. **Files that contain links (to edit):** + - `release-notes/v4-tucker/4.1.0.md` — `/docs/4.1/configuration#*` and `/docs/4.1/custom-functions/*` - `release-notes/v4-tucker/4.2.0.md` — `/docs/reference/resources`, `/docs/reference/components/*` - `release-notes/v4-tucker/4.3.0.md` — `/docs/reference/resources` @@ -55,6 +56,7 @@ Update links in `release-notes/` and `learn/` that point to old doc paths, mappi ### Learn Guides (`learn/`) Only 4 content files currently exist (most are stubs): + - `learn/developers/harper-applications-in-depth.mdx` - `learn/getting-started/create-your-first-application.mdx` - `learn/getting-started/install-and-connect-harper.mdx` @@ -62,40 +64,48 @@ Only 4 content files currently exist (most are stubs): Links found in `harper-applications-in-depth.mdx`: -| Old Path | New Path | -|----------|----------| +| Old Path | New Path | +| ------------------------------------------------ | ------------------------------------------------------------ | | `/docs/reference/components/built-in-extensions` | `/docs/v4/components/overview#built-in-extensions-reference` | -| `/docs/reference/resources` | `/docs/v4/resources/overview` | -| `/docs/reference/globals#logger` | `/docs/v4/logging/api` | -| `/docs/reference/resources/` | `/docs/v4/resources/overview` | -| `/docs/reference/components/` | `/docs/v4/components/overview` | +| `/docs/reference/resources` | `/docs/v4/resources/overview` | +| `/docs/reference/globals#logger` | `/docs/v4/logging/api` | +| `/docs/reference/resources/` | `/docs/v4/resources/overview` | +| `/docs/reference/components/` | `/docs/v4/components/overview` | --- ## Procedure ### Step 1: Verify URL prefix + Before editing any links, confirm what the new URL prefix is for `reference_versioned_docs/version-v4/`. Check: + ```bash cat docusaurus.config.js | grep -A5 "reference_versioned" # or cat reference_versioned_sidebars/version-v4-sidebars.json | head -5 ``` + The prefix is likely `/docs/v4/` but confirm before proceeding. ### Step 2: Find all affected release note files + ```bash grep -rl "/docs/" release-notes/v4-tucker/ ``` + This gives the exact list of files to edit. ### Step 3: Edit release notes + For each affected file, replace old `/docs/` paths with new `/docs/v4/` paths per the mapping table above. ### Step 4: Edit learn guides + Read each of the 4 learn guide files, apply the mapping table above. ### Step 5: Check for any remaining old-path links across the whole repo + ```bash grep -rn "/docs/reference/" --include="*.md" --include="*.mdx" release-notes/ learn/ grep -rn "/docs/developers/" --include="*.md" --include="*.mdx" release-notes/ learn/ @@ -105,6 +115,7 @@ grep -rn "/docs/4\." --include="*.md" --include="*.mdx" release-notes/ learn/ ``` ### Step 6: Commit + - Commit release notes changes: `docs(cross-refs): update old /docs/ links in release notes to v4 reference paths` - Commit learn guide changes: `docs(cross-refs): update old /docs/ links in learn guides to v4 reference paths` diff --git a/reference_versioned_docs/version-v4/analytics/operations.md b/reference_versioned_docs/version-v4/analytics/operations.md index db17194c..e82d3086 100644 --- a/reference_versioned_docs/version-v4/analytics/operations.md +++ b/reference_versioned_docs/version-v4/analytics/operations.md @@ -83,13 +83,13 @@ Queries analytics data for a specific metric over a time range. ### Parameters -| Parameter | Required | Type | Description | -| ---------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `operation` | Yes | string | Must be `"get_analytics"` | -| `metric` | Yes | string | Metric name — use `list_metrics` to get valid values | -| `start_time` | No | number | Start of time range as Unix timestamp in milliseconds | -| `end_time` | No | number | End of time range as Unix timestamp in milliseconds | -| `get_attributes` | No | string[] | Attributes to include in each result. If omitted, all attributes are returned | +| Parameter | Required | Type | Description | +| ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------- | +| `operation` | Yes | string | Must be `"get_analytics"` | +| `metric` | Yes | string | Metric name — use `list_metrics` to get valid values | +| `start_time` | No | number | Start of time range as Unix timestamp in milliseconds | +| `end_time` | No | number | End of time range as Unix timestamp in milliseconds | +| `get_attributes` | No | string[] | Attributes to include in each result. If omitted, all attributes are returned | | `conditions` | No | object[] | Additional filter conditions. Same format as [`search_by_conditions`](../operations-api/operations.md#nosql-operations) | ### Request diff --git a/reference_versioned_docs/version-v4/cli/operations-api-commands.md b/reference_versioned_docs/version-v4/cli/operations-api-commands.md index 3b21ddb3..bdfd49f5 100644 --- a/reference_versioned_docs/version-v4/cli/operations-api-commands.md +++ b/reference_versioned_docs/version-v4/cli/operations-api-commands.md @@ -34,80 +34,80 @@ The following operations are available through the CLI. Operations that require This is just a brief overview of all operations available as CLI commands. Review the respective operation documentation for more information on available arguments and expected behavior. Keep in mind that all operations options are converted to CLI arguments in the same way (using `snake_case`). ::: -| Operation | Description | Category | Available Since | -| -------------------------------- | ------------------------------------- | ---------------------------------------------------------- | --------------- | -| `describe_table` | Describe table structure and metadata | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `describe_all` | Describe all databases and tables | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `describe_database` | Describe database structure | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `create_database` | Create a new database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `drop_database` | Delete a database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `create_table` | Create a new table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `drop_table` | Delete a table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `create_attribute` | Create a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `drop_attribute` | Delete a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | -| `search_by_id` | Search records by ID | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `search_by_value` | Search records by attribute value | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `insert` | Insert new records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | -| `update` | Update existing records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | -| `upsert` | Insert or update records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | -| `delete` | Delete records | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `sql` | Execute SQL queries | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `csv_file_load` | Load data from CSV file | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `csv_url_load` | Load data from CSV URL | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | -| `list_users` | List all users | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `add_user` | Create a new user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `alter_user` | Modify user properties | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `drop_user` | Delete a user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `list_roles` | List all roles | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `drop_role` | Delete a role | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | -| `create_csr` | Create certificate signing request | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `sign_certificate` | Sign a certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `list_certificates` | List SSL/TLS certificates | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `add_certificate` | Add SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `remove_certificate` | Remove SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `add_ssh_key` | Add SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `get_ssh_key` | Get SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.7.2 | -| `update_ssh_key` | Update SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `delete_ssh_key` | Delete SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `list_ssh_keys` | List all SSH keys | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `set_ssh_known_hosts` | Set SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `get_ssh_known_hosts` | Get SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | -| `cluster_get_routes` | Get cluster routing information | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | -| `cluster_network` | Get cluster network status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | -| `cluster_status` | Get cluster status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | -| `remove_node` | Remove node from cluster | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | -| `add_component` | Add a component | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `deploy_component` | Deploy a component | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `deploy` (alias) | Alias for `deploy_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `package_component` | Package a component | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `package` (alias) | Alias for `package_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `drop_component` | Remove a component | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `get_components` | List all components | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `get_component_file` | Get component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `set_component_file` | Set component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `install_node_modules` | Install Node.js dependencies | [Components](../operations-api/operations.md#components) | v4.3.0 | -| `set_configuration` | Update configuration settings | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | -| `get_configuration` | Get current configuration | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | +| Operation | Description | Category | Available Since | +| -------------------------------- | ------------------------------------- | ---------------------------------------------------------------------- | --------------- | +| `describe_table` | Describe table structure and metadata | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `describe_all` | Describe all databases and tables | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `describe_database` | Describe database structure | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_database` | Create a new database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_database` | Delete a database | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_table` | Create a new table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_table` | Delete a table | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `create_attribute` | Create a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `drop_attribute` | Delete a table attribute | [Database](../operations-api/operations.md#databases--tables) | v4.3.0 | +| `search_by_id` | Search records by ID | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `search_by_value` | Search records by attribute value | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `insert` | Insert new records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `update` | Update existing records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `upsert` | Insert or update records | [Data](../operations-api/operations.md#nosql-operations) | v4.4.9 | +| `delete` | Delete records | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `sql` | Execute SQL queries | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `csv_file_load` | Load data from CSV file | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `csv_url_load` | Load data from CSV URL | [Data](../operations-api/operations.md#nosql-operations) | v4.3.0 | +| `list_users` | List all users | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `add_user` | Create a new user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `alter_user` | Modify user properties | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `drop_user` | Delete a user | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `list_roles` | List all roles | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `drop_role` | Delete a role | [Security](../operations-api/operations.md#certificate-management) | v4.3.0 | +| `create_csr` | Create certificate signing request | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `sign_certificate` | Sign a certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `list_certificates` | List SSL/TLS certificates | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `add_certificate` | Add SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `remove_certificate` | Remove SSL/TLS certificate | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `add_ssh_key` | Add SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `get_ssh_key` | Get SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.7.2 | +| `update_ssh_key` | Update SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `delete_ssh_key` | Delete SSH key | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `list_ssh_keys` | List all SSH keys | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `set_ssh_known_hosts` | Set SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `get_ssh_known_hosts` | Get SSH known hosts | [Security](../operations-api/operations.md#certificate-management) | v4.4.0 | +| `cluster_get_routes` | Get cluster routing information | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `cluster_network` | Get cluster network status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `cluster_status` | Get cluster status | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `remove_node` | Remove node from cluster | [Clustering](../operations-api/operations.md#replication--clustering) | v4.3.0 | +| `add_component` | Add a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `deploy_component` | Deploy a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `deploy` (alias) | Alias for `deploy_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `package_component` | Package a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `package` (alias) | Alias for `package_component` | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `drop_component` | Remove a component | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `get_components` | List all components | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `get_component_file` | Get component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `set_component_file` | Set component file contents | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `install_node_modules` | Install Node.js dependencies | [Components](../operations-api/operations.md#components) | v4.3.0 | +| `set_configuration` | Update configuration settings | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | +| `get_configuration` | Get current configuration | [Configuration](../operations-api/operations.md#configuration) | v4.3.0 | | `create_authentication_tokens` | Create authentication tokens | [Authentication](../operations-api/operations.md#token-authentication) | v4.3.0 | | `refresh_operation_token` | Refresh operation token | [Authentication](../operations-api/operations.md#token-authentication) | v4.3.0 | -| `restart_service` | Restart Harper service | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `restart` | Restart Harper instance | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `system_information` | Get system information | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `registration_info` | Get registration information | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `get_fingerprint` | Get instance fingerprint | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `set_license` | Set license key | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | -| `get_usage_licenses` | Get usage and license info | [Licensing](../operations-api/operations.md#registration--licensing) | v4.7.3 | -| `get_job` | Get job status | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | -| `search_jobs_by_start_date` | Search jobs by start date | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | -| `read_log` | Read application logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | -| `read_transaction_log` | Read transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | -| `read_audit_log` | Read audit logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | -| `delete_transaction_logs_before` | Delete old transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | -| `purge_stream` | Purge streaming data | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | -| `delete_records_before` | Delete old records | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | -| `get_status` | Get custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | -| `set_status` | Set custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | -| `clear_status` | Clear custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | +| `restart_service` | Restart Harper service | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `restart` | Restart Harper instance | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `system_information` | Get system information | [System](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `registration_info` | Get registration information | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `get_fingerprint` | Get instance fingerprint | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `set_license` | Set license key | [Licensing](../operations-api/operations.md#registration--licensing) | v4.3.0 | +| `get_usage_licenses` | Get usage and license info | [Licensing](../operations-api/operations.md#registration--licensing) | v4.7.3 | +| `get_job` | Get job status | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | +| `search_jobs_by_start_date` | Search jobs by start date | [Jobs](../operations-api/operations.md#jobs) | v4.3.0 | +| `read_log` | Read application logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `read_transaction_log` | Read transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `read_audit_log` | Read audit logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `delete_transaction_logs_before` | Delete old transaction logs | [Logging](../operations-api/operations.md#logs) | v4.3.0 | +| `purge_stream` | Purge streaming data | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | +| `delete_records_before` | Delete old records | [Maintenance](../operations-api/operations.md#jobs) | v4.3.0 | +| `get_status` | Get custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | +| `set_status` | Set custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | +| `clear_status` | Clear custom status information | [Status](../operations-api/operations.md#registration--licensing) | v4.6.0 | ### Command Aliases