search

F5Networks / f5-telemetry-streaming

F5 BIG-IP Telemetry Streaming
Apache License 2.0
56 stars 23 forks source link

Partial documentation - Schema Reference #219

Open SankoZaha opened 2 years ago

SankoZaha commented 2 years ago

Is your feature request related to a problem?

F5's CloudDocs documentation is quite imprecise on several aspects.

The schema reference lists all the properties for a given object: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/schema-reference.html

For example, the "telemetry_consumer" object gives the list of valid properties for this object. However, there is no distinction on the properties applicable by type of consumer.

Some properties are specific to one type of consumer only and are not interpreted for another. There is the following page: https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/setting-up-consumer.html but it doesn't describe "all" of the properties applicable by type of consumer.

Also most properties don't have a description and/or don't describe the values ​​they can take : image

Describe the solution you'd like

An update of the F5's ClouDocs documentation on the Appendix A: Schema Reference

dstokesf5 commented 2 years ago

Thank you for your feedback. I have added TS-709 to our internal product backlog to fill in the missing descriptions on the Telemetry_Consumer class.