doc: provide code comment on how to handle autodiscover in FalconContainerSensorImageURI

redhatrises · redhatrises · commit f1ec10823c94 · 2025-01-28T10:22:17.000-07:00
diff --git a/falcon/containers.go b/falcon/containers.go
@@ -38,6 +38,8 @@ func FalconContainerUploadURI(falconCloud CloudType) string {
 }
 
 // FalconContainerSensorImageURI returns a URI for downloading a container sensor image. Defaults to the falcon-sensor image.
+// When the Falcon Cloud CloudType is set to CloudAutoDiscover, be sure to provide the results of ApiConfig.Cloud after the client
+// has been initialized to ensure the correct CloudType is used and not CloudAutoDiscover.
 func FalconContainerSensorImageURI(falconCloud CloudType, sensorType SensorType) string {
 	switch sensorType {
 	case SidecarSensor:

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ func FalconContainerUploadURI(falconCloud CloudType) string {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// FalconContainerSensorImageURI returns a URI for downloading a container sensor image. Defaults to the falcon-sensor image.`
	`41`	`+// When the Falcon Cloud CloudType is set to CloudAutoDiscover, be sure to provide the results of ApiConfig.Cloud after the client`
	`42`	`+// has been initialized to ensure the correct CloudType is used and not CloudAutoDiscover.`
`41`	`43`	`func FalconContainerSensorImageURI(falconCloud CloudType, sensorType SensorType) string {`
`42`	`44`	`switch sensorType {`
`43`	`45`	`case SidecarSensor:`