updateSpecifications #

The updateSpecifications method allows you to create or update the validation specifications for a collection.

When the validation specification is not formatted correctly, a detailed error message is returned to help you to debug.

Copied to clipboard!

updateSpecifications(index, collection, specifications, [options]);

Arguments	Type	Description
index	string	Index name
collection	string	Collection name
specifications	object	Specifications to update
options	object	Query options

specifications #

An object representing the specifications.

This object must follow the Specification Structure:

Copied to clipboard!

{
  strict: <boolean>,
  fields: {
    // ... specification for each field
  }
}

options #

Additional query options

Property	Type (default)	Description
queuable	boolean (true)	If true, queues the request during downtime, until connected to Kuzzle again

Resolves #

Resolve to an object containing the specifications.

Usage #

Copied to clipboard!

const specifications = {
  strict: false,
  fields: {
    license: {
      mandatory: true,
      type: 'string'
    }
  }
};
try {
  const result = await kuzzle.collection.updateSpecifications('nyc-open-data', 'yellow-taxi', specifications);
  console.log(result);
  /*
    { strict: false,
      fields: {
        license: {
          mandatory: true,
          type: 'string' } } }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}