Merge pull request #4427 from LiilyZhang/zhangl/updateAgbotSwagger

Update swagger doc for agbot secure api

Author: LiilyZhang

agreementbot/secrets/secrets.go

@@ -53,7 +53,7 @@ type AgbotSecrets interface {
 	GetSecretMetadata(secretOrg, secretUser, secretNode, secretName string) (SecretMetadata, error)
 }
 
-// SecretDetails The key value pair of one secret
+// SecretDetails The key value pair of one secret.
 // swagger:model SecretDetails
 type SecretDetails struct {
 	// Key is the name of the secret

agreementbot/secure_api.go

@@ -13,7 +13,6 @@ import (
 const DEFAULT_MAX_AGREEMENT = 0
 
 // BusinessPolicy the business policy
-// swagger:model
 type BusinessPolicy struct {
 	Owner         string                              `json:"owner,omitempty"`
 	Label         string                              `json:"label"`

businesspolicy/business_policy.go

@@ -18,7 +18,6 @@ type AbstractPatternFile interface {
 // PatternFile An implementation of AbstractPatternFile.
 //
 // It is used when reading json file the user gives us as an input to create the pattern
-// swagger:model
 type PatternFile struct {
 	Name               string                         `json:"name,omitempty"`
 	Org                string                         `json:"org,omitempty"` // optional

common/pattern_file.go

@@ -27,7 +27,6 @@ type AbstractServiceFile interface {
 // ServiceFile An implementation of AbstractServiceFile
 //
 // It is used when reading json file the user gives us as input to create the service
-// swagger:model
 type ServiceFile struct {
 	Org                        string                             `json:"org"` // optional
 	Label                      string                             `json:"label"`

common/service_file.go

@@ -60,7 +60,8 @@ func NewCompCheckError(err error, errCode int) *CompCheckError {
 	}
 }
 
-// The input format for the comptible check
+// The input format for the compatibility check.
+// swagger:model
 type CompCheck struct {
 	NodeId              string                         `json:"node_id,omitempty"`
 	NodeArch            string                         `json:"node_arch,omitempty"`
@@ -141,7 +142,7 @@ func (p *CompCheck) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
-// CompCheckOutput The output format for the compatibility check
+// The output format for the compatibility check.
 // swagger:model
 type CompCheckOutput struct {
 	Compatible bool               `json:"compatible"`

compcheck/comp_check.go

@@ -16,7 +16,8 @@ import (
 	"golang.org/x/text/message"
 )
 
-// The input format for the policy check
+// The input format for the policy check.
+// swagger:model
 type PolicyCheck struct {
 	NodeId              string                                `json:"node_id,omitempty"`
 	NodeArch            string                                `json:"node_arch,omitempty"`

compcheck/policy_check.go

@@ -15,7 +15,8 @@ import (
 	"strings"
 )
 
-// The input format for the userinput check
+// The input format for the secret binding check.
+// swagger:model
 type SecretBindingCheck struct {
 	NodeId         string                                `json:"node_id,omitempty"`
 	NodeArch       string                                `json:"node_arch,omitempty"`

compcheck/secretbinding_check.go

@@ -15,7 +15,8 @@ import (
 	"strings"
 )
 
-// The input format for the userinput check
+// The input format for the userinput check.
+// swagger:model
 type UserInputCheck struct {
 	NodeId              string                                `json:"node_id,omitempty"`
 	NodeArch            string                                `json:"node_arch,omitempty"`