pkg/api/validate: add comments for exported methods

marquiz · marquiz · commit c0c4bb648ae4 · 2025-08-29T13:34:22.000+03:00
Signed-off-by: Markus Lehtonen &lt;markus.lehtonen@intel.com&gt;
diff --git a/pkg/api/validate.go b/pkg/api/validate.go
@@ -20,22 +20,26 @@ import (
 	"fmt"
 )
 
+// AddPlugin records a plugin for the validation request.
 func (v *ValidateContainerAdjustmentRequest) AddPlugin(name, index string) {
 	v.Plugins = append(v.Plugins, &PluginInstance{
 		Name:  name,
 		Index: index,
 	})
 }
 
+// AddResponse records the container adjustments and updates to validate from a CreateContainerResponse.
 func (v *ValidateContainerAdjustmentRequest) AddResponse(rpl *CreateContainerResponse) {
 	v.Adjust = rpl.Adjust
 	v.Update = rpl.Update
 }
 
+// AddOwners sets the owning plugins for the container adjustment request.
 func (v *ValidateContainerAdjustmentRequest) AddOwners(owners *OwningPlugins) {
 	v.Owners = owners
 }
 
+// ValidationResult returns the validation result as an error (non-nil if rejected).
 func (v *ValidateContainerAdjustmentResponse) ValidationResult(plugin string) error {
 	if !v.Reject {
 		return nil
@@ -49,6 +53,7 @@ func (v *ValidateContainerAdjustmentResponse) ValidationResult(plugin string) er
 	return fmt.Errorf("validator %q rejected container adjustment, reason: %s", plugin, reason)
 }
 
+// GetPluginMap returns a map of plugin name to PluginInstance.
 func (v *ValidateContainerAdjustmentRequest) GetPluginMap() map[string]*PluginInstance {
 	if v == nil {
 		return nil

Original file line number	Diff line number	Diff line change
`@@ -20,22 +20,26 @@ import (`
`20`	`20`	`"fmt"`
`21`	`21`	`)`
`22`	`22`
	`23`	`+// AddPlugin records a plugin for the validation request.`
`23`	`24`	`func (v *ValidateContainerAdjustmentRequest) AddPlugin(name, index string) {`
`24`	`25`	`v.Plugins = append(v.Plugins, &PluginInstance{`
`25`	`26`	`Name: name,`
`26`	`27`	`Index: index,`
`27`	`28`	`})`
`28`	`29`	`}`
`29`	`30`
	`31`	`+// AddResponse records the container adjustments and updates to validate from a CreateContainerResponse.`
`30`	`32`	`func (v ValidateContainerAdjustmentRequest) AddResponse(rpl CreateContainerResponse) {`
`31`	`33`	`v.Adjust = rpl.Adjust`
`32`	`34`	`v.Update = rpl.Update`
`33`	`35`	`}`
`34`	`36`
	`37`	`+// AddOwners sets the owning plugins for the container adjustment request.`
`35`	`38`	`func (v ValidateContainerAdjustmentRequest) AddOwners(owners OwningPlugins) {`
`36`	`39`	`v.Owners = owners`
`37`	`40`	`}`
`38`	`41`
	`42`	`+// ValidationResult returns the validation result as an error (non-nil if rejected).`
`39`	`43`	`func (v *ValidateContainerAdjustmentResponse) ValidationResult(plugin string) error {`
`40`	`44`	`if !v.Reject {`
`41`	`45`	`return nil`
`@@ -49,6 +53,7 @@ func (v *ValidateContainerAdjustmentResponse) ValidationResult(plugin string) er`
`49`	`53`	`return fmt.Errorf("validator %q rejected container adjustment, reason: %s", plugin, reason)`
`50`	`54`	`}`
`51`	`55`
	`56`	`+// GetPluginMap returns a map of plugin name to PluginInstance.`
`52`	`57`	`func (v ValidateContainerAdjustmentRequest) GetPluginMap() map[string]PluginInstance {`
`53`	`58`	`if v == nil {`
`54`	`59`	`return nil`