getSpecifications #

Returns the validation specifications associated to the collection.

Signature #

std::string getSpecifications(
    const std::string& index,
    const std::string& collection);

std::string getSpecifications(
    const std::string& index,
    const std::string& collection,
    const kuzzleio::query_options& options);

Arguments #

Arguments	Type	Description
`index`	const std::string&	Index name
`collection`	const std::string&	Collection name
`options`	kuzzleio::query_options*	Query options

options #

Additional query options

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

Return #

A JSON string representing the validation specifications.

Usage #

try {
  std::string specifications = kuzzle->collection->getSpecifications("nyc-open-data", "yellow-taxi");
  std::cout << specifications << std::endl;
  // {"nyc-open-data": {"yellow-taxi": {"strict": false, "fields": {"license": {"type": "string"}}}}}
} catch (kuzzleio::KuzzleException &e) {
  std::cerr << e.what() << std::endl;
}

Edit this page on Github