docs: clarify observed API behaviours (rights inheritance, formulas, properties, auth) - #11
Open
mitselek wants to merge 1 commit into
Open
docs: clarify observed API behaviours (rights inheritance, formulas, properties, auth)#11mitselek wants to merge 1 commit into
mitselek wants to merge 1 commit into
Conversation
…ies, auth) Documents several Entu API/platform behaviours that an external integrator (the mvox project) verified empirically against a live database but which weren't yet covered in the docs. Each addition corresponds to an open issue with probe results. - entities: a 'what propagates between entities' section (type↔instance vs parent↔child); multi-parent rights are a union, materialised, eventually consistent, and carry an 'inherited' flag. - formulas: single-hop references only; output is always a scalar (never a reference); evaluator bypasses access rights (safe for aggregates, not raw projection); CONCAT_WS partial/duplicate-input behaviour. - properties: the last-_owner guard is direct-delete only. - authentication: add-a-login-method (invite self-link) flow. - entity-types: reference_query is a static filter (no per-instance substitution). English (src/) only — leaving the Estonian (src/et/) mirror to maintainers. Co-authored-by: Mihkel Putrinš <mihkel.putrinsh@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents several Entu API/platform behaviours that we (the team behind mvox, an Entu-backed app) verified empirically against a live database while building on Entu, but which were not yet covered in the docs. Each addition maps to an open issue with probe results, listed below so this single merge closes them.
Pure markdown additions in
src/(English) using the existing:::admonition style. We deliberately left the Estoniansrc/et/mirror untouched — happy to follow up with translations, but the wording is yours to finalise first.What is documented
inheritedflagCONCAT_WSpartial/duplicate-input behaviour_ownerguard is direct-delete onlyreference_queryis a static filterNotes
Closes #2
Closes #3
Closes #4
Closes #5
Closes #6
Closes #7
Closes #8
Closes #9
Closes #10