yaqc public api for accessing the avro protocol #5
Description
Client programs may have reason to show information in the avro protocol.
for example a case brought by @dan.d.kohler of wanting to display the options for an enum type defined in the protocol.
Currently the only field we have as a public attribute is traits which is helpful, but perhaps insufficient.
We have private attributes for the protocol and the named types, that we could make public if we want. (named types being a map where the types from the protocol are a list)
other things we can consider:
- config and state (most likely usecase is getting the default values for some reason, but generally less useful as clients are not supposed to manipulate config and state directly, aside from very specific usecases like the ni daq configuration program)
- Disposition: do not put at top level, those interested can read from the full protocol
- hardware, links and installation information (most likely use case is displaying on an informational page/providing clickable links)
- Disposition: do not put at top level, those interested can read from the full protocol