Add read-only support to openapiv2

grpc-ecosystem · Mar 1, 2019 · c1de7cc · c1de7cc
1 parent 0c2b3b1
commit c1de7cc
Show file tree

Hide file tree

Showing 7 changed files with 155 additions and 140 deletions.
diff --git a/internal/stream_chunk.pb.go b/internal/stream_chunk.pb.go
diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -275,6 +275,7 @@ func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject,
 
 			// Warning: Make sure not to overwrite any fields already set on the schema type.
 			schema.ExternalDocs = protoSchema.ExternalDocs
+			schema.ReadOnly = protoSchema.ReadOnly
 			schema.MultipleOf = protoSchema.MultipleOf
 			schema.Maximum = protoSchema.Maximum
 			schema.ExclusiveMaximum = protoSchema.ExclusiveMaximum
@@ -1539,6 +1540,7 @@ func protoJSONSchemaToSwaggerSchemaCore(j *swagger_options.JSONSchema, reg *desc
 func updateSwaggerObjectFromJSONSchema(s *swaggerSchemaObject, j *swagger_options.JSONSchema) {
 	s.Title = j.GetTitle()
 	s.Description = j.GetDescription()
+	s.ReadOnly = j.GetReadOnly()
 	s.MultipleOf = j.GetMultipleOf()
 	s.Maximum = j.GetMaximum()
 	s.ExclusiveMaximum = j.GetExclusiveMaximum()

diff --git a/protoc-gen-swagger/genswagger/template_test.go b/protoc-gen-swagger/genswagger/template_test.go
@@ -1274,6 +1274,7 @@ func TestRenderMessagesAsDefinition(t *testing.T) {
 						MaxProperties:    33,
 						MinProperties:    22,
 						Required:         []string{"req"},
+						ReadOnly:         true,
 					},
 				},
 			},
@@ -1298,6 +1299,7 @@ func TestRenderMessagesAsDefinition(t *testing.T) {
 					MaxProperties:    33,
 					MinProperties:    22,
 					Required:         []string{"req"},
+					ReadOnly:         true,
 				},
 			},
 		},

diff --git a/protoc-gen-swagger/genswagger/types.go b/protoc-gen-swagger/genswagger/types.go
@@ -209,6 +209,7 @@ type swaggerSchemaObject struct {
 
 	ExternalDocs *swaggerExternalDocumentationObject `json:"externalDocs,omitempty"`
 
+	ReadOnly         bool     `json:"readOnly,omitempty"`
 	MultipleOf       float64  `json:"multipleOf,omitempty"`
 	Maximum          float64  `json:"maximum,omitempty"`
 	ExclusiveMaximum bool     `json:"exclusiveMaximum,omitempty"`

diff --git a/protoc-gen-swagger/options/annotations.pb.go b/protoc-gen-swagger/options/annotations.pb.go