Proto enum validation + documentation rework #129

Baccata · 2024-01-12T15:45:41Z

Amends protobuf-related validation to be aware of the constraint that all proto enumerations should have a 0, and that open enumerations should avoid using the protoIndex trait as they are meant to be processed as raw string or raw ints.

Also starts reworking validation :

splits the README into smaller files : serialisation-related docs, and protocol-related docs
incorporate the protobuf documentation from smithy-translate in here, as the semantics of the translation should be derived from the meaning that we give to the smithy constructs in alloy
reword some of the documentation to be more formal sounding (reword usage of "we" into passives , fully expend "don't", etc)

TODOs :

Extract general-purpose traits into their own section (openEnum, UUID, etc)
Link all extracted documents in the readme

1. Open enums should not carry @protoIndex 2. Closed enums the members of which have proto indexes should have one set to 0.

Amends protobuf-related validation to be aware of the constraint that all proto enumerations should have a `0`, and that open enumerations should avoid using the `protoIndex` trait as they are meant to be processed as raw string or raw ints.

docs/serialisation/protobuf.md

modules/core/src/alloy/proto/validation/ProtoIndexTraitValidator.java

daddykotex

minor comments: regarding the proto index phasing, which is better than field number I guess, but I'm fine keeping it as is

also two leftover println I found

Baccata added 3 commits January 11, 2024 15:10

Adds validation logic for enums :

f04302b

1. Open enums should not carry @protoIndex 2. Closed enums the members of which have proto indexes should have one set to 0.

WIP : restructure / rework documentation

7a98046