fix doc

wI2L · Dec 22, 2021 · 2994b14 · 2994b14
1 parent 4dc6938
commit 2994b14
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/openapi/spec.go b/openapi/spec.go
@@ -376,7 +376,7 @@ func (sor *SecuritySchemeOrRef) MarshalYAML() (interface{}, error) {
 	return sor.Reference, nil
 }
 
-// SecurityScheme represents how the API is secured
+// SecurityScheme represents a security scheme that can be used by an operation.
 type SecurityScheme struct {
 	Type             string      `json:"type,omitempty" yaml:"type,omitempty"`
 	Scheme           string      `json:"scheme,omitempty" yaml:"scheme,omitempty"`
@@ -388,15 +388,15 @@ type SecurityScheme struct {
 	Flows            *OAuthFlows `json:"flows,omitempty" yaml:"flows,omitempty"`
 }
 
-// OAuthFlows represents all the supported OAuth flows
+// OAuthFlows represents all the supported OAuth flows.
 type OAuthFlows struct {
 	Implicit          *OAuthFlow `json:"implicit,omitempty" yaml:"implicit,omitempty"`
 	Password          *OAuthFlow `json:"password,omitempty" yaml:"password,omitempty"`
 	ClientCredentials *OAuthFlow `json:"clientCredentials,omitempty" yaml:"clientCredentials,omitempty"`
 	AuthorizationCode *OAuthFlow `json:"authorizationCode,omitempty" yaml:"authorizationCode,omitempty"`
 }
 
-// OAuthFlow represents the data required to define an OAuth security scheme.
+// OAuthFlow represents an OAuth security scheme.
 type OAuthFlow struct {
 	AuthorizationURL string            `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"`
 	TokenURL         string            `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"`
@@ -407,7 +407,7 @@ type OAuthFlow struct {
 // SecurityRequirement represents the security object in the API specification.
 type SecurityRequirement map[string][]string
 
-// XLogo represents the information about the x-logo extension
+// XLogo represents the information about the x-logo extension.
 // See: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-logo
 type XLogo struct {
 	URL             string `json:"url,omitempty" yaml:"url,omitempty"`
@@ -416,14 +416,14 @@ type XLogo struct {
 	Href            string `json:"href,omitempty" yaml:"href,omitempty"`
 }
 
-// XTagGroup represents the information about the x-tagGroups extension
+// XTagGroup represents the information about the x-tagGroups extension.
 // See: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-taggroups
 type XTagGroup struct {
 	Name string   `json:"name,omitempty" yaml:"name,omitempty"`
 	Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"`
 }
 
-// XCodeSample represents the information about the x-codeSample extension
+// XCodeSample represents the information about the x-codeSample extension.
 // See: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codesamples
 type XCodeSample struct {
 	Lang   string `json:"lang,omitempty" yaml:"lang,omitempty"`