Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the use of the visibilityProperty and timestampProperty schema fields #509

Open
GCHQDeveloper314 opened this issue Jun 10, 2024 · 0 comments
Labels
enhancement Improvement to an existing part of the documentation
Milestone

Comments

@GCHQDeveloper314
Copy link
Member

The "Optional Element fields" section of the Schema docs states that Edges and Entities can optionally have visibilityProperty and timestampProperty 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 inside config (also mentioned in the deprecations):

{
  "entities": {},
  "edges": {},
  "visibilityProperty": "visibility",
  "config": {
    "timestampProperty": "timestamp"
  }
}

Further detail should be added to this page so it's clear how the visibilityProperty and timestampProperty 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.

@GCHQDeveloper314 GCHQDeveloper314 added the enhancement Improvement to an existing part of the documentation label Jun 10, 2024
@GCHQDeveloper314 GCHQDeveloper314 added this to the Backlog milestone Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing part of the documentation
Projects
None yet
Development

No branches or pull requests

1 participant