Skip to content

Commit 173842e

Browse files
committed
feat(docs): Add content about interface fields as found in original docs (#534)
Signed-off-by: Maximilian Rosin <[email protected]>
1 parent f574da4 commit 173842e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/architecture/architecture_overview.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,12 @@ image::osi-traffic-participant-advanced.png[1100]
2525

2626
OSI currently provides only limited support for data structures describing measured internal states of the traffic participant.
2727
Actuator intentions are currently not covered by OSI and must be handled with a different data description format.
28+
29+
All fields in an interface are set to optional and required is not used.
30+
This has been done to allow backward compatible changes in the field.
31+
Additionally, this is the default behavior in protobuf version 3 that does no longer have the required type and therefore ensures update compatibility.
32+
However, this does not mean that filling the field is optional.
33+
For the purpose of providing a complete interface, all existing fields should be set, unless not setting a field carries a specific meaning as indicated in the accompanying comment.
34+
35+
All field numbers of 10000 and upward are available for user-specific extensions via custom fields.
36+
Therefore, no future evolution of OSI will use field numbers of 10000 or above.

0 commit comments

Comments
 (0)