Merge pull request #4428 from LiilyZhang/zhangl/updateAgbotSwagger

Issue #4406 - Documentation: Update swagger json for agbo…

Author: LiilyZhang

agreementbot/secrets/secrets.go

@@ -56,13 +56,11 @@ type AgbotSecrets interface {
 // SecretDetails The key value pair of one secret.
 // swagger:model SecretDetails
 type SecretDetails struct {
-	// Key is the name of the secret
-	//
-	// required: true
+	// The name of the secret
+	//   required: true
 	Key string `json:"key"`
-	// Value is the value of the secret
-	//
-	// required: true
+	// The value of the secret
+	//   required: true
 	Value string `json:"value"`
 }
 

businesspolicy/business_policy.go

@@ -12,7 +12,7 @@ import (
 
 const DEFAULT_MAX_AGREEMENT = 0
 
-// BusinessPolicy the business policy
+// BusinessPolicy is the policy for deploying a service to targeted nodes
 type BusinessPolicy struct {
 	Owner         string                              `json:"owner,omitempty"`
 	Label         string                              `json:"label"`

compcheck/comp_check.go

@@ -164,7 +164,7 @@ func NewCompCheckOutput(compatible bool, reason map[string]string, input *CompCh
 	}
 }
 
-// To store the resource (pattern, bp, services etc) used for compatibility check
+// The resource that is used for the compatibility check. The resource is a pattern, business policy, service, or other type of resource
 type CompCheckResource struct {
 	NodeId              string                                   `json:"node_id,omitempty"`
 	NodeArch            string                                   `json:"node_arch,omitempty"`
@@ -180,11 +180,9 @@ type CompCheckResource struct {
 	Pattern             common.AbstractPatternFile               `json:"pattern,omitempty"`
 	ServicePolicy       map[string]externalpolicy.ExternalPolicy `json:"service_policy,omitempty"`
 	Service             []common.AbstractServiceFile             `json:"service,omitempty"`
-	DepServices         map[string]exchange.ServiceDefinition    `json:"dependent_services,omitempty"` // for internal use for performance. A map of service definition keyed by id.
-	// It is either empty or provides ALL the dependent services needed. It is expected the top level service definitions are provided
-	// in the 'Service' attribute when this attribute is not empty.
-	NeededSB     []exchangecommon.SecretBinding `json:"needed_secret_binding,omitempty"`
-	ExtraneousSB []exchangecommon.SecretBinding `json:"extraneous_secret_binding,omitempty"`
+	DepServices         map[string]exchange.ServiceDefinition    `json:"dependent_services,omitempty"` // for internal use for performance. A map of service definition keyed by id. It is either empty or provides ALL the dependent services needed. It is expected the top level service definitions are provided in the 'Service' attribute when this attribute is not empty.
+	NeededSB            []exchangecommon.SecretBinding           `json:"needed_secret_binding,omitempty"`
+	ExtraneousSB        []exchangecommon.SecretBinding           `json:"extraneous_secret_binding,omitempty"`
 }
 
 func (p CompCheckResource) String() string {