Skip to content

docs(access-rule-model): declare IDTA-01002 as SoT for formula grammar (T-01)#83

Open
aorzelskiGH wants to merge 1 commit into
IDTA-01004-3-1_Workingfrom
docs/formula-grammar-sot
Open

docs(access-rule-model): declare IDTA-01002 as SoT for formula grammar (T-01)#83
aorzelskiGH wants to merge 1 commit into
IDTA-01004-3-1_Workingfrom
docs/formula-grammar-sot

Conversation

@aorzelskiGH
Copy link
Copy Markdown
Contributor

Summary

Add an IMPORTANT block to the Access Rule Model chapter that names IDTA-01002 (Query Language chapter and its JSON Schema) as the normative single source of truth for all shared formula productions.

Problem

Today IDTA-01002 and IDTA-01004 ship duplicated BNF fragments and JSON Schema blocks for formula expressions (logical expressions, comparisons, FieldIdentifiers, value literals, type casts, $match/$and/$or/$not). The two copies are maintained in parallel but no text states which one is authoritative, which has led to recurring drift (e.g. timeLiteralPattern, $dayOfWeek refs, supplementalSemanticIds).

Solution

  • Add a normative IMPORTANT block right after the existing cross-reference to the Query Language chapter.
  • State that formula productions are normatively defined in IDTA-01002.
  • State that IDTA-01004 only adds Access-Rule-specific productions (ACL, OBJECTS, RIGHTS, ACCESS, ROUTE, FILTER, DEFATTRIBUTES, DEFACLS, DEFOBJECTS, DEFFORMULAS, ...) on top of the shared grammar.
  • Clarify that bugfixes to shared productions in IDTA-01002 are automatically inherited by IDTA-01004.

Affected files

  • documentation/IDTA-01004/modules/ROOT/pages/access-rule-model.adoc

Review notes

  • Pure documentation change, no normative change to the grammar or schema content.
  • Companion PR in aas-specs-api adds the mirrored normative subsection.

Refs: Review Finding T-01

Add an IMPORTANT block next to the cross-reference to the
Query Language chapter that explicitly names IDTA-01002
(Query Language chapter and its JSON Schema) as the
normative single source of truth for shared formula
productions.

This specification (IDTA-01004) only adds Access-Rule-specific
productions (ACL, OBJECTS, RIGHTS, ACCESS, ROUTE, FILTER,
DEFATTRIBUTES, DEFACLS, DEFOBJECTS, DEFFORMULAS, ...) on top
of the shared grammar. Bugfixes to shared productions in
IDTA-01002 are automatically inherited.

Refs: Review Finding T-01
Made-with: Cursor

[IMPORTANT]
====
*Single source of truth.* The BNF grammar and JSON Schema productions for *formula expressions* (logical expressions, comparisons, FieldIdentifiers, value literals, operands, type casts, and `$match` / `$and` / `$or` / `$not` operators) are *normatively defined in IDTA-01002 Part 2* (Query Language chapter and its JSON Schema).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants