Clarify the use of the visibilityProperty and timestampProperty schema fields #509
Labels
enhancement
Improvement to an existing part of the documentation
Milestone
The "Optional Element fields" section of the Schema docs states that Edges and Entities can optionally have
visibilityProperty
andtimestampProperty
fields.However, the page doesn't give examples of how these should be used in a Schema. It's not clear if these properties can be specified for Edges and Entities. They are not used in this way in example schemas for Gaffer tests. These fields are instead used at a global level within a schema, with the
timestampProperty
field being nested insideconfig
(also mentioned in the deprecations):Further detail should be added to this page so it's clear how the
visibilityProperty
andtimestampProperty
fields can be used. It might be possible to use these properties at the level of specific Edges and Entities as well as globally - this needs to be confirmed.The text was updated successfully, but these errors were encountered: