Schema validation - compliance auditing via Studio

[reebhub]

related issues:
RDoc-3594 Explain schema validation auditing via Studio
RDoc-3603 Explain the schema validation playground
RDoc-3624 Index schema definition field added to Studio
RDoc-3622 Add a schema validation configuration page

[haludi]

Maybe worth mentioning the link?
https://docs.ravendb.net/6.0/indexes/storing-data-in-index/

[reebhub]

done

[haludi]

I don't think the term "collection schema" is the right term here.
As I see it, "database schema" or equivalent is more accurate

[reebhub]

==>

• If you define only a database-level schema, the index will use it.
• If you define only an index-level schema, the index will use it.
• If you define both, the index-level schema will take precedence.

[haludi]

Unless the index is using the definition from the database.
That is the case where you use Schema.GetErrorFor, but you don't define a schema for the index

[reebhub]

==>
Note: When the index uses a database-level schema, disabling validation at the database level will also disable auditing by the index.
However, when the index uses an index-level schema, disabling database-level validation will not disable auditing by the index.

[haludi]

Also, here, the distinction, as I see it, should be between database schema and index schema

[reebhub]

#### Define a validation schema

The index will use the schema defined in its index configuration.  
See how to add a schema to the index configuration [below](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio#create-the-audit-index).  
* If no schema is defined in the index configuration, the index will use the [database-level schema](../../../documents/schema-validation/write-validation/write-validation_studio#creating-a-collection-schema).  
* If no schema is defined either in the index configuration or at the database level, the index will not perform any validation.

<Admonition type="note" title="">
**Note**: When the index uses a database-level schema, [disabling validation at the database level](../../../documents/schema-validation/write-validation/write-validation_studio#managing-and-testing-existing-schemas) will also disable auditing by the index.  
However, when the index uses an index-level schema, disabling database-level validation will **not** disable auditing by the index.
</Admonition>

[reebhub]

changed it the same way in the API page

[haludi]

This is not accurate.
The Store option set to Yes tells the index to actually store the value.
The default is just keeping the tokens (not the actual value)

[reebhub]

==>
Set the Store option for this field to Yes, to store the actual error messages in the index rather than just their tokens.

[haludi]

It sounds too complex to me here.
I would write something like "If you like an index dedicated schema to use inside the index."
But this is minor.

[reebhub]

==>

• If you prefer that the index use an index-level schema, add it in the Schema definition tab.

[haludi]

Can we change the examples to filter first out valid documents?
In this way, the number of entries in the index is the number of invalid documents.
Also, it means that most of the time, when all the data is vali,d the resource cost of the index is minimal (no entries)

from doc in docs
let errors = Schema.GetErrorsFor(doc)
where errors != null && errors.Length > 0
select new 
{
    Id = doc.Id,
    Errors = errors
}

map("@all_docs", (doc) => { 
    let errors = schema.getErrorsFor(doc);
    if( errors != null && errors.length > 0)
        return {
            Id: id(doc),
            Errors: errors
        };
})

[reebhub]

done