Merge pull request #25 from padiazg/fix-missing-description-for-operation

Fix operation "description" must be present and non-empty string.

Author: kaynetik

build.go

@@ -137,6 +137,7 @@ func makeAllPathsMap(paths *Paths) pathsMap {
 		pathMap[keyTags] = path.Tags
 		pathMap[keySummary] = path.Summary
 		pathMap[keyOperationID] = path.OperationID
+		pathMap[keyDescription] = path.Description
 		pathMap[keySecurity] = makeSecurityMap(&path.Security)
 		pathMap[keyRequestBody] = makeRequestBodyMap(&path.RequestBody)
 		pathMap[keyResponses] = makeResponsesMap(&path.Responses)

examples/api-documentation.go

@@ -5,7 +5,7 @@ import "github.com/go-oas/docs"
 func handleCreateUserRoute(oasPathIndex int, oas *docs.OAS) {
 	path := oas.GetPathByIndex(oasPathIndex)
 
-	path.Summary = "Create a new User"
+	path.Description = "Create a new User"
 	path.OperationID = "createUser"
 
 	path.RequestBody = docs.RequestBody{
@@ -34,7 +34,7 @@ func handleCreateUserRoute(oasPathIndex int, oas *docs.OAS) {
 func handleGetUserRoute(oasPathIndex int, oas *docs.OAS) {
 	path := oas.GetPathByIndex(oasPathIndex)
 
-	path.Summary = "Get a User"
+	path.Description = "Get a User"
 	path.OperationID = "getUser"
 	path.RequestBody = docs.RequestBody{}
 	path.Responses = docs.Responses{

models.go

@@ -98,6 +98,7 @@ type Path struct {
 	HTTPMethod      string           `yaml:"httpMethod"`
 	Tags            []string         `yaml:"tags"`
 	Summary         string           `yaml:"summary"`
+	Description     string           `yaml:"description"`
 	OperationID     string           `yaml:"operationId"`
 	RequestBody     RequestBody      `yaml:"requestBody"`
 	Responses       Responses        `yaml:"responses"`