Skip to content

Generate a doc string comment for the record #42

Closed
@pleshakov

Description

@pleshakov

The F5 telemetry service requires a doc string comment for the record:

Wrong:

@namespace("gateway.nginx.org") protocol NGFProductTelemetry {
	@df_datatype("ngf-product-telemetry") record Data {
		/** The field that identifies what type of data this is. */
		string dataType;
                . . . 

Correct:

@namespace("gateway.nginx.org") protocol NGFProductTelemetry {
	/** Data is the product telemetry data of NGINX Gateway Fabric. */
	@df_datatype("ngf-product-telemetry") record Data {
		/** The field that identifies what type of data this is. */
		string dataType;
                . . . 

Metadata

Metadata

Assignees

Labels

bugAn issue reporting a potential bugrefinedIssues that are ready to be prioritized

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions