New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate a doc string comment for the record #42

Open

pleshakov opened this issue Mar 7, 2024 · 0 comments

Labels

bug

Contributor

pleshakov commented Mar 7, 2024

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;
                . . .

The text was updated successfully, but these errors were encountered:

pleshakov added the bug label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment