Updated description to clarify that quotes need to be escaped in metadata.

joevanwanzeeleKF · joevanwanzeeleKF · commit 743622f81150 · 2025-02-03T15:09:47.000-05:00
diff --git a/fields.go b/fields.go
@@ -77,8 +77,10 @@ be larger than the role max TTL.`,
 	}
 
 	fields["metadata"] = &framework.FieldSchema{
-		Type:        framework.TypeString,
-		Description: `Metadata in JSON format to be passed along with the signing request and associated with the certificate in Command.`,
+		Type: framework.TypeString,
+		Description: `Metadata in JSON format to be passed along with the signing request and associated with the certificate in Command.  
+		Quotation marks should be escaped.  
+		Example: ... metadata='{ \"testMetadata\": \"arbitrary string value\" }`,
 	}
 
 	return fields

Original file line number	Diff line number	Diff line change
@@ -77,8 +77,10 @@ be larger than the role max TTL.`,
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`fields["metadata"] = &framework.FieldSchema{`
`80`		`- Type: framework.TypeString,`
`81`		- Description: `Metadata in JSON format to be passed along with the signing request and associated with the certificate in Command.`,
	`80`	`+ Type: framework.TypeString,`
	`81`	+ Description: `Metadata in JSON format to be passed along with the signing request and associated with the certificate in Command.
	`82`	`+ Quotation marks should be escaped.`
	`83`	+ Example: ... metadata='{ \"testMetadata\": \"arbitrary string value\" }`,
`82`	`84`	`}`
`83`	`85`
`84`	`86`	`return fields`