Skip to content
This repository was archived by the owner on May 12, 2021. It is now read-only.
This repository was archived by the owner on May 12, 2021. It is now read-only.

Document all protocol elements #150

@jodh-intel

Description

@jodh-intel

We should document all Messages and all message members for the *.proto files in:

This will:

Additional to the description, we should pay particular attention to string fields due to their increased flexibility (and thus increased ability to confuse):

  • What is the format of each string member?
  • Can the value be ""? If so, what does it mean?
  • Are there any other "special" values (like the terrible golang net.IP "<nil>" value)?

Example where we have ambiguity:

message StringUser {
	string uid = 1;
	string gid = 2;
	repeated string additionalGids = 3;
}

Are those member values numbers encoded as strings ("3", "1000", "0")? Or can they also (?) be specified as symbolics ("adm", "james", "root")?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovement to an existing featureneeds-helpRequest for extra help (technical, resource, etc)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions