support for read only, test by adding read only attribute to id of pet (

#529)
swaggo · Sep 23, 2019 · efcfb3d · efcfb3d
1 parent b09d3f5
commit efcfb3d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/parser.go b/parser.go
@@ -751,6 +751,7 @@ type structField struct {
 	arrayType    string
 	formatType   string
 	isRequired   bool
+	readOnly     bool
 	crossPkg     string
 	exampleValue interface{}
 	maximum      *float64
@@ -835,6 +836,9 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 					Ref: jsonreference.MustCreateRef("#/definitions/" + pkgName + "." + structField.schemaType),
 				},
 			},
+			SwaggerSchemaProps: spec.SwaggerSchemaProps{
+				ReadOnly: structField.readOnly,
+			},
 		}
 	} else if structField.schemaType == "array" { // array field type
 		// if defined -- ref it
@@ -855,6 +859,9 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 						},
 					},
 				},
+				SwaggerSchemaProps: spec.SwaggerSchemaProps{
+					ReadOnly: structField.readOnly,
+				},
 			}
 		} else if structField.arrayType == "object" {
 			// Anonymous struct
@@ -883,7 +890,11 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 									},
 								},
 							},
-						}}
+						},
+						SwaggerSchemaProps: spec.SwaggerSchemaProps{
+							ReadOnly: structField.readOnly,
+						},
+					}
 				}
 			}
 		} else {
@@ -914,7 +925,8 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 					},
 				},
 				SwaggerSchemaProps: spec.SwaggerSchemaProps{
-					Example: structField.exampleValue,
+					Example:  structField.exampleValue,
+					ReadOnly: structField.readOnly,
 				},
 			}
 		}
@@ -937,7 +949,8 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 				Default:     structField.defaultValue,
 			},
 			SwaggerSchemaProps: spec.SwaggerSchemaProps{
-				Example: structField.exampleValue,
+				Example:  structField.exampleValue,
+				ReadOnly: structField.readOnly,
 			},
 			VendorExtensible: spec.VendorExtensible{
 				Extensions: structField.extensions,
@@ -989,7 +1002,8 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
 					Default:     structField.defaultValue,
 				},
 				SwaggerSchemaProps: spec.SwaggerSchemaProps{
-					Example: structField.exampleValue,
+					Example:  structField.exampleValue,
+					ReadOnly: structField.readOnly,
 				},
 			}
 		}
@@ -1185,6 +1199,9 @@ func (parser *Parser) parseField(field *ast.Field) (*structField, error) {
 		}
 		structField.minLength = minLength
 	}
+	if readOnly := structTag.Get("readonly"); readOnly != "" {
+		structField.readOnly = readOnly == "true"
+	}
 
 	return structField, nil
 }

diff --git a/parser_test.go b/parser_test.go
@@ -669,6 +669,7 @@ func TestParseSimpleApi1(t *testing.T) {
                 "id": {
                     "type": "integer",
                     "format": "int64",
+                    "readOnly": true,
                     "example": 1
                 },
                 "int_array": {

diff --git a/testdata/simple/web/handler.go b/testdata/simple/web/handler.go
@@ -9,7 +9,7 @@ import (
 )
 
 type Pet struct {
-	ID       int `json:"id" example:"1" format:"int64"`
+	ID       int `json:"id" example:"1" format:"int64" readonly:"true"`
 	Category struct {
 		ID            int      `json:"id" example:"1"`
 		Name          string   `json:"name" example:"category_name"`