diff --git a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx index 1896cc196a..953fc61438 100644 --- a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx +++ b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx @@ -34,7 +34,7 @@ import Panel from "@site/src/components/Panel"; -Use this audit approach to examine the [compliance of documents in a collection](../../../documents/schema-validation/schema-validation_overview#running-an-audit-operation) with a validation schema. You can limit the number of documents to be checked and the number of error messages returned. +Use this audit approach to examine the [compliance of documents in a collection](../../../documents/schema-validation/overview#running-an-audit-operation) with a validation schema. You can limit the number of documents to be checked and the number of error messages returned. This method is useful for one-time audits or periodic checks of data integrity. To execute this audit, run `StartSchemaValidationOperation`. The operation will scan the documents in the specified collection, validate each document against the provided JSON schema, and produce a report of any validation errors. diff --git a/docs/documents/schema-validation/schema-validation_configuration.mdx b/docs/documents/schema-validation/configuration.mdx similarity index 92% rename from docs/documents/schema-validation/schema-validation_configuration.mdx rename to docs/documents/schema-validation/configuration.mdx index 080807bf19..58a9948e32 100644 --- a/docs/documents/schema-validation/schema-validation_configuration.mdx +++ b/docs/documents/schema-validation/configuration.mdx @@ -19,9 +19,9 @@ import Panel from "@site/src/components/Panel"; This page aims to clarify the scope of settings and configurations related to schema validation. * In this article: - * [Enabling and disabling validation for the database](../../documents/schema-validation/schema-validation_configuration#enabling-and-disabling-validation-for-the-database) - * [Per-collection configuration](../../documents/schema-validation/schema-validation_configuration#per-collection-configuration) - * [Index configuration](../../documents/schema-validation/schema-validation_configuration#index-configuration) + * [Enabling and disabling validation for the database](../../documents/schema-validation/configuration#enabling-and-disabling-validation-for-the-database) + * [Per-collection configuration](../../documents/schema-validation/configuration#per-collection-configuration) + * [Index configuration](../../documents/schema-validation/configuration#index-configuration) diff --git a/docs/documents/schema-validation/schema-validation_overview.mdx b/docs/documents/schema-validation/overview.mdx similarity index 93% rename from docs/documents/schema-validation/schema-validation_overview.mdx rename to docs/documents/schema-validation/overview.mdx index 653fac07ea..17178ae972 100644 --- a/docs/documents/schema-validation/schema-validation_overview.mdx +++ b/docs/documents/schema-validation/overview.mdx @@ -19,7 +19,7 @@ import Panel from "@site/src/components/Panel"; * A validation schema is a JSON object associated with a document collection. If a schema is enabled for a collection, the collection's documents can be written only if the documents comply with the constraints defined by the schema. -* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks. +* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks. * Validating document compliance during writing can help ensure data consistency (e.g., by preventing the saving of documents with missing required fields) and simplify read-time handling by preventing the need for additional checks and transformations. @@ -31,12 +31,12 @@ import Panel from "@site/src/components/Panel"; - By [validating documents during indexing](../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api#audit-document-compliance-by-index) and embedding validation error messages in the indexes. * In this article: - * [The validation process](../../documents/schema-validation/schema-validation_overview#the-validation-process) - * [A list of operations that trigger validation](../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation) - * [Available constraints](../../documents/schema-validation/schema-validation_overview#available-constraints) - * [Considerations](../../documents/schema-validation/schema-validation_overview#considerations) - * [Auditing schema validation](../../documents/schema-validation/schema-validation_overview#auditing-schema-validation) - * [Use cases](../../documents/schema-validation/schema-validation_overview#use-cases) + * [The validation process](../../documents/schema-validation/overview#the-validation-process) + * [A list of operations that trigger validation](../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation) + * [Available constraints](../../documents/schema-validation/overview#available-constraints) + * [Considerations](../../documents/schema-validation/overview#considerations) + * [Auditing schema validation](../../documents/schema-validation/overview#auditing-schema-validation) + * [Use cases](../../documents/schema-validation/overview#use-cases) diff --git a/docs/documents/schema-validation/write-validation/write-validation_api.mdx b/docs/documents/schema-validation/write-validation/write-validation_api.mdx index 4383919fe9..0694cef786 100644 --- a/docs/documents/schema-validation/write-validation/write-validation_api.mdx +++ b/docs/documents/schema-validation/write-validation/write-validation_api.mdx @@ -142,7 +142,7 @@ await store.Maintenance.SendAsync(new ConfigureSchemaValidationOperation(configu ``` -Once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks. (See a list of [operations that trigger validation](../../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation).) +Once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks. (See a list of [operations that trigger validation](../../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation).) diff --git a/docs/documents/schema-validation/write-validation/write-validation_studio.mdx b/docs/documents/schema-validation/write-validation/write-validation_studio.mdx index 849085eac0..6013b9873e 100644 --- a/docs/documents/schema-validation/write-validation/write-validation_studio.mdx +++ b/docs/documents/schema-validation/write-validation/write-validation_studio.mdx @@ -16,7 +16,7 @@ import Panel from "@site/src/components/Panel"; # Write validation: Studio -Manage [schema validation](../../../documents/schema-validation/schema-validation_overview) using the Studio **Document Schema** view, to condition documents storage on their compliance with a defined JSON schema. +Manage [schema validation](../../../documents/schema-validation/overview) using the Studio **Document Schema** view, to condition documents storage on their compliance with a defined JSON schema. * In this article: * [The Document Schema view](../../../documents/schema-validation/write-validation/write-validation_studio#the-document-schema-view) @@ -73,7 +73,7 @@ To create a validation schema, open: **Settings** > **Document schema** > **Add ``` - [See a list of available constraints.](../../../documents/schema-validation/schema-validation_overview#available-constraints) + [See a list of available constraints.](../../../documents/schema-validation/overview#available-constraints) 3. **Save** @@ -86,7 +86,7 @@ To create a validation schema, open: **Settings** > **Document schema** > **Add Note that once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks. - [See a list of operations that trigger validation](../../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation). + [See a list of operations that trigger validation](../../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation). diff --git a/src/components/Homepage/Features/FeaturesLists/DocumentExtensionsFeatures.tsx b/src/components/Homepage/Features/FeaturesLists/DocumentExtensionsFeatures.tsx index e2246b60f0..bb2e45d3c5 100644 --- a/src/components/Homepage/Features/FeaturesLists/DocumentExtensionsFeatures.tsx +++ b/src/components/Homepage/Features/FeaturesLists/DocumentExtensionsFeatures.tsx @@ -52,7 +52,7 @@ export default function DocumentExtensionsFeaturesGrid() { { title: "JSON Schema Validation", icon: "document-schema", - url: `/${activeVersion.label}/documents/schema-validation/schema-validation_overview`, + url: `/${activeVersion.label}/documents/schema-validation/overview`, description: "Simple, scalable, and conflict-free numeric counters", minimumSupportedVersion: "7.2", },