getSpecifications

Returns the validation specifications associated to the given index and collection.


Copied to clipboard!
getSpecifications(index, collection, [options]);

Arguments Type Description
index
string
Index name
collection
string
Collection name
options
object
Query options

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 representing the collection specifications.

Usage

Copied to clipboard!
try {
  const specifications = await kuzzle.collection.getSpecifications('nyc-open-data', 'yellow-taxi');
  console.log(specifications);
  /*
    {
      "collection": "yellow-taxi",
      "index": "nyc-open-data",
      "validation": {
        "fields": {
          "age": {
            "defaultValue": 42,
            "mandatory": true,
            "type": "integer"
          }
        },
        "strict": true
      }
    }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}