Unknown SDK


Update parts of a specification, by replacing some fields or adding new ones.
Note that you cannot remove fields this way: missing fields will simply be left unchanged.

updateSpecifications(content, [options], [callback])

Arguments Type Description
content JSON object Content of the specification to update
options JSON object Optional parameters
callback function Optional callback


Option Type Description Default
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait the persistence layer to finish indexing (available with Elasticsearch 5.x and above) undefined
retryOnConflict int Number of retries to attempt before rejecting this update because of a cluster sync conflict 0

Return Value

Returns the Collection object to allow chaining.


Copied to clipboard!
var specifications = {
  strict: 'true',
  fields: {
    foo: {
      mandatory: true,
      type: 'string',
      defaultValue: 'bar'
// Using callbacks (NodeJS or Web Browser)
  .collection('collection', 'index')
  .updateSpecifications(specifications, function (err, res) {
    // result is a JSON object
// Using promises (NodeJS)
  .collection('collection', 'index')
  .then(res => {
    // result is a JSON object

Callback response

Copied to clipboard!
  "index": {
    "collection": {
      "strict": "true",
      "fields": {
        "foo": {
          "mandatory": "true",
          "type": "string",
          "defaultValue": "bar"