schema.collections

Schema file

type	object
properties
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
moduleId	The id of the collection module
	type	string
collectionName	The collection name
	type	string
filters	MongoDB expression that represents the filters that can be applied to this collection.
	type	array
	items	CollectionFilter
indexes	The indexes to build on the Mongo Database for the collection
	type	array
	items	IndexConfigurationEntity
autoIncrementFields	The list of fields that must be incremented automatically when inserting a new element. This fields must be type integer
	type	array
	items	type	string
noDuplicatesFields	The list of fields that cannot have duplicates values. This only applies to values that are arrays
	type	array
	items	type	string
historizeCollection	When set as true, each operation on an entry of this collection is reported inside the collections_history collection. This allows to get a previous state of a collection entry.
	type	boolean
	default	True
ttlAfterDelete	Time to live (TTL) in seconds of an entry before it is fully removed from the database after it was deleted. When deleting an entry with a delete request, the flag __is_active is set to false, making this entry not appear in request. If value is 0, the entry is never fully deleted.
	type	integer
	default	0
additionalProperties	False

CollectionFilter

type	object
properties
id	A reference to this collection filter.
	type	string
query	MongoDB expression that represents the filter to apply.
additionalProperties	False

IndexConfigurationEntity

type	object
properties
name	The name of the index
	type	string
index	The Mongo expression used for indexing. See https://docs.mongodb.com/manual/indexes/ for more information.
sparse	Create the indexes only the document when the field exist
	type	boolean
	default	False
partialFilterExpression	Partial filter expression used to filter the elements that are affected by this index
additionalProperties	False