Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

protoc-gen-swagger: honor example field of message option #799

Merged
merged 4 commits into from
Jan 9, 2019
Merged

protoc-gen-swagger: honor example field of message option #799

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8c96ec
fill example attribute of swagger schema if provided for messages
birdayz Nov 7, 2018
850e066
fix nil dereference
birdayz Nov 7, 2018
114c72f
use json.RawMessage for property & object examples
birdayz Nov 8, 2018
86f635e
goimports
birdayz Nov 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions protoc-gen-swagger/genswagger/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import (
"strings"
"sync"

"encoding/json"
birdayz marked this conversation as resolved.
Show resolved Hide resolved

"github.com/golang/protobuf/proto"
pbdescriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
Expand Down Expand Up @@ -274,6 +276,9 @@ func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject,
if protoSchema.Description != "" {
schema.Description = protoSchema.Description
}
if protoSchema.Example != nil {
schema.Example = protoSchema.Example
}
}

for _, f := range msg.Fields {
Expand Down Expand Up @@ -1425,6 +1430,10 @@ func swaggerSchemaFromProtoSchema(s *swagger_options.Schema, reg *descriptor.Reg
ret.schemaCore = protoJSONSchemaToSwaggerSchemaCore(s.GetJsonSchema(), reg, refs)
updateSwaggerObjectFromJSONSchema(&ret, s.GetJsonSchema())

if s != nil && s.Example != nil {
ret.Example = json.RawMessage(s.Example.Value)
}

return ret
}

Expand Down
7 changes: 4 additions & 3 deletions protoc-gen-swagger/genswagger/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,10 @@ type swaggerParameterObject struct {
// core part of schema, which is common to itemsObject and schemaObject.
// http://swagger.io/specification/#itemsObject
type schemaCore struct {
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
Ref string `json:"$ref,omitempty"`
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
Ref string `json:"$ref,omitempty"`
Example json.RawMessage `json:"example,omitempty"`

Items *swaggerItemsObject `json:"items,omitempty"`

Expand Down