README.md

sonic-dash-api

This repository hosts the DASH API definition for the SONiC project. The schema of DASH APP DB is at DASH APP DB and all entries of DASH APP DB will be encoded as protobuf.

Protobuf Convention

1. File name use underscore case, E.G. acl_rule.proto
2. All file except common utility should include and only include one message of entry and one message of its key.
3. Message name of entry use camel case. E.G. AclRule.
4. Message name of entry key use the entry name with a fixed postfix Key. E.G. AclRuleKey.
5. If the value of entry is a list, the item use the entry name with a fixed postfix Item. E.G. RouteTypeItem.
6. Member variable use underscore case. E.G. src_addr.
7. For enumerations type, the enum name use camel case, E.G. IpVersion
8. The field of enum use full capital with underscore case, and the enum name use as the prefix for each field. E.G. IP_VERSION_IPV4

Redis DB

1. Table name will be full capital with underscore. And the prefix DASH and postfix Table will be added to entry name. E.G. DASH_VNET_MAPPING_TABLE
2. The key message is sequentially joint as the Redis key with colon separator. E.G. AclRuleKey{group_id=group1, rule_num=3}, the key of Redis entry will be DASH_ACL_RULE_TABLE:group1:3
3. The value is the entry message with the bytes array of protobuf

GNMI

TODO