Committing vendored dependencies and generated protos
Change-Id: I349c149b513d9de7d9f60bde2c954a939da2fc54
diff --git a/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/BUILD.bazel b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/BUILD.bazel
new file mode 100644
index 0000000..929d0cf
--- /dev/null
+++ b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/BUILD.bazel
@@ -0,0 +1,46 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+
+package(default_visibility = ["//protoc-gen-swagger:__subpackages__"])
+
+go_library(
+ name = "go_default_library",
+ srcs = [
+ "doc.go",
+ "generator.go",
+ "template.go",
+ "types.go",
+ ],
+ importpath = "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger",
+ deps = [
+ "//internal:go_default_library",
+ "//protoc-gen-grpc-gateway/descriptor:go_default_library",
+ "//protoc-gen-grpc-gateway/generator:go_default_library",
+ "//protoc-gen-swagger/options:go_default_library",
+ "@com_github_golang_glog//:go_default_library",
+ "@com_github_golang_protobuf//descriptor:go_default_library_gen",
+ "@com_github_golang_protobuf//jsonpb:go_default_library_gen",
+ "@com_github_golang_protobuf//proto:go_default_library",
+ "@com_github_golang_protobuf//protoc-gen-go/generator:go_default_library_gen",
+ "@io_bazel_rules_go//proto/wkt:any_go_proto",
+ "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
+ "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
+ "@io_bazel_rules_go//proto/wkt:struct_go_proto",
+ ],
+)
+
+go_test(
+ name = "go_default_test",
+ size = "small",
+ srcs = ["template_test.go"],
+ embed = [":go_default_library"],
+ deps = [
+ "//protoc-gen-grpc-gateway/descriptor:go_default_library",
+ "//protoc-gen-grpc-gateway/httprule:go_default_library",
+ "//protoc-gen-swagger/options:go_default_library",
+ "@com_github_golang_protobuf//proto:go_default_library",
+ "@io_bazel_rules_go//proto/wkt:any_go_proto",
+ "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
+ "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
+ "@io_bazel_rules_go//proto/wkt:struct_go_proto",
+ ],
+)
diff --git a/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/doc.go b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/doc.go
new file mode 100644
index 0000000..4d28716
--- /dev/null
+++ b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/doc.go
@@ -0,0 +1,2 @@
+// Package genswagger provides a code generator for swagger.
+package genswagger
diff --git a/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/generator.go b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/generator.go
new file mode 100644
index 0000000..31409ac
--- /dev/null
+++ b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/generator.go
@@ -0,0 +1,247 @@
+package genswagger
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ "path/filepath"
+ "reflect"
+ "strings"
+
+ "github.com/golang/glog"
+ pbdescriptor "github.com/golang/protobuf/descriptor"
+ "github.com/golang/protobuf/proto"
+ protocdescriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
+ plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
+ "github.com/golang/protobuf/ptypes/any"
+ "github.com/grpc-ecosystem/grpc-gateway/internal"
+ "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
+ gen "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/generator"
+ swagger_options "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/options"
+)
+
+var (
+ errNoTargetService = errors.New("no target service defined in the file")
+)
+
+type generator struct {
+ reg *descriptor.Registry
+}
+
+type wrapper struct {
+ fileName string
+ swagger *swaggerObject
+}
+
+// New returns a new generator which generates grpc gateway files.
+func New(reg *descriptor.Registry) gen.Generator {
+ return &generator{reg: reg}
+}
+
+// Merge a lot of swagger file (wrapper) to single one swagger file
+func mergeTargetFile(targets []*wrapper, mergeFileName string) *wrapper {
+ var mergedTarget *wrapper
+ for _, f := range targets {
+ if mergedTarget == nil {
+ mergedTarget = &wrapper{
+ fileName: mergeFileName,
+ swagger: f.swagger,
+ }
+ } else {
+ for k, v := range f.swagger.Definitions {
+ mergedTarget.swagger.Definitions[k] = v
+ }
+ for k, v := range f.swagger.StreamDefinitions {
+ mergedTarget.swagger.StreamDefinitions[k] = v
+ }
+ for k, v := range f.swagger.Paths {
+ mergedTarget.swagger.Paths[k] = v
+ }
+ for k, v := range f.swagger.SecurityDefinitions {
+ mergedTarget.swagger.SecurityDefinitions[k] = v
+ }
+ mergedTarget.swagger.Security = append(mergedTarget.swagger.Security, f.swagger.Security...)
+ }
+ }
+ return mergedTarget
+}
+
+func fieldName(k string) string {
+ return strings.ReplaceAll(strings.Title(k), "-", "_")
+}
+
+// Q: What's up with the alias types here?
+// A: We don't want to completely override how these structs are marshaled into
+// JSON, we only want to add fields (see below, extensionMarshalJSON).
+// An infinite recursion would happen if we'd call json.Marshal on the struct
+// that has swaggerObject as an embedded field. To avoid that, we'll create
+// type aliases, and those don't have the custom MarshalJSON methods defined
+// on them. See http://choly.ca/post/go-json-marshalling/ (or, if it ever
+// goes away, use
+// https://web.archive.org/web/20190806073003/http://choly.ca/post/go-json-marshalling/.
+func (so swaggerObject) MarshalJSON() ([]byte, error) {
+ type alias swaggerObject
+ return extensionMarshalJSON(alias(so), so.extensions)
+}
+
+func (so swaggerInfoObject) MarshalJSON() ([]byte, error) {
+ type alias swaggerInfoObject
+ return extensionMarshalJSON(alias(so), so.extensions)
+}
+
+func (so swaggerSecuritySchemeObject) MarshalJSON() ([]byte, error) {
+ type alias swaggerSecuritySchemeObject
+ return extensionMarshalJSON(alias(so), so.extensions)
+}
+
+func (so swaggerOperationObject) MarshalJSON() ([]byte, error) {
+ type alias swaggerOperationObject
+ return extensionMarshalJSON(alias(so), so.extensions)
+}
+
+func (so swaggerResponseObject) MarshalJSON() ([]byte, error) {
+ type alias swaggerResponseObject
+ return extensionMarshalJSON(alias(so), so.extensions)
+}
+
+func extensionMarshalJSON(so interface{}, extensions []extension) ([]byte, error) {
+ // To append arbitrary keys to the struct we'll render into json,
+ // we're creating another struct that embeds the original one, and
+ // its extra fields:
+ //
+ // The struct will look like
+ // struct {
+ // *swaggerCore
+ // XGrpcGatewayFoo json.RawMessage `json:"x-grpc-gateway-foo"`
+ // XGrpcGatewayBar json.RawMessage `json:"x-grpc-gateway-bar"`
+ // }
+ // and thus render into what we want -- the JSON of swaggerCore with the
+ // extensions appended.
+ fields := []reflect.StructField{
+ reflect.StructField{ // embedded
+ Name: "Embedded",
+ Type: reflect.TypeOf(so),
+ Anonymous: true,
+ },
+ }
+ for _, ext := range extensions {
+ fields = append(fields, reflect.StructField{
+ Name: fieldName(ext.key),
+ Type: reflect.TypeOf(ext.value),
+ Tag: reflect.StructTag(fmt.Sprintf("json:\"%s\"", ext.key)),
+ })
+ }
+
+ t := reflect.StructOf(fields)
+ s := reflect.New(t).Elem()
+ s.Field(0).Set(reflect.ValueOf(so))
+ for _, ext := range extensions {
+ s.FieldByName(fieldName(ext.key)).Set(reflect.ValueOf(ext.value))
+ }
+ return json.Marshal(s.Interface())
+}
+
+// encodeSwagger converts swagger file obj to plugin.CodeGeneratorResponse_File
+func encodeSwagger(file *wrapper) (*plugin.CodeGeneratorResponse_File, error) {
+ var formatted bytes.Buffer
+ enc := json.NewEncoder(&formatted)
+ enc.SetIndent("", " ")
+ if err := enc.Encode(*file.swagger); err != nil {
+ return nil, err
+ }
+ name := file.fileName
+ ext := filepath.Ext(name)
+ base := strings.TrimSuffix(name, ext)
+ output := fmt.Sprintf("%s.swagger.json", base)
+ return &plugin.CodeGeneratorResponse_File{
+ Name: proto.String(output),
+ Content: proto.String(formatted.String()),
+ }, nil
+}
+
+func (g *generator) Generate(targets []*descriptor.File) ([]*plugin.CodeGeneratorResponse_File, error) {
+ var files []*plugin.CodeGeneratorResponse_File
+ if g.reg.IsAllowMerge() {
+ var mergedTarget *descriptor.File
+ // try to find proto leader
+ for _, f := range targets {
+ if proto.HasExtension(f.Options, swagger_options.E_Openapiv2Swagger) {
+ mergedTarget = f
+ break
+ }
+ }
+ // merge protos to leader
+ for _, f := range targets {
+ if mergedTarget == nil {
+ mergedTarget = f
+ } else {
+ mergedTarget.Enums = append(mergedTarget.Enums, f.Enums...)
+ mergedTarget.Messages = append(mergedTarget.Messages, f.Messages...)
+ mergedTarget.Services = append(mergedTarget.Services, f.Services...)
+ }
+ }
+
+ targets = nil
+ targets = append(targets, mergedTarget)
+ }
+
+ var swaggers []*wrapper
+ for _, file := range targets {
+ glog.V(1).Infof("Processing %s", file.GetName())
+ swagger, err := applyTemplate(param{File: file, reg: g.reg})
+ if err == errNoTargetService {
+ glog.V(1).Infof("%s: %v", file.GetName(), err)
+ continue
+ }
+ if err != nil {
+ return nil, err
+ }
+ swaggers = append(swaggers, &wrapper{
+ fileName: file.GetName(),
+ swagger: swagger,
+ })
+ }
+
+ if g.reg.IsAllowMerge() {
+ targetSwagger := mergeTargetFile(swaggers, g.reg.GetMergeFileName())
+ f, err := encodeSwagger(targetSwagger)
+ if err != nil {
+ return nil, fmt.Errorf("failed to encode swagger for %s: %s", g.reg.GetMergeFileName(), err)
+ }
+ files = append(files, f)
+ glog.V(1).Infof("New swagger file will emit")
+ } else {
+ for _, file := range swaggers {
+ f, err := encodeSwagger(file)
+ if err != nil {
+ return nil, fmt.Errorf("failed to encode swagger for %s: %s", file.fileName, err)
+ }
+ files = append(files, f)
+ glog.V(1).Infof("New swagger file will emit")
+ }
+ }
+ return files, nil
+}
+
+//AddStreamError Adds grpc.gateway.runtime.StreamError and google.protobuf.Any to registry for stream responses
+func AddStreamError(reg *descriptor.Registry) error {
+ //load internal protos
+ any := fileDescriptorProtoForMessage(&any.Any{})
+ streamError := fileDescriptorProtoForMessage(&internal.StreamError{})
+ if err := reg.Load(&plugin.CodeGeneratorRequest{
+ ProtoFile: []*protocdescriptor.FileDescriptorProto{
+ any,
+ streamError,
+ },
+ }); err != nil {
+ return err
+ }
+ return nil
+}
+
+func fileDescriptorProtoForMessage(msg pbdescriptor.Message) *protocdescriptor.FileDescriptorProto {
+ fdp, _ := pbdescriptor.ForMessage(msg)
+ fdp.SourceCodeInfo = &protocdescriptor.SourceCodeInfo{}
+ return fdp
+}
diff --git a/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/template.go b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/template.go
new file mode 100644
index 0000000..3d97207
--- /dev/null
+++ b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/template.go
@@ -0,0 +1,1764 @@
+package genswagger
+
+import (
+ "encoding/json"
+ "fmt"
+ "os"
+ "reflect"
+ "regexp"
+ "sort"
+ "strconv"
+ "strings"
+ "sync"
+
+ "github.com/golang/glog"
+ "github.com/golang/protobuf/jsonpb"
+ "github.com/golang/protobuf/proto"
+ structpb "github.com/golang/protobuf/ptypes/struct"
+ pbdescriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
+ gogen "github.com/golang/protobuf/protoc-gen-go/generator"
+ "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
+ swagger_options "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/options"
+)
+
+var wktSchemas = map[string]schemaCore{
+ ".google.protobuf.Timestamp": schemaCore{
+ Type: "string",
+ Format: "date-time",
+ },
+ ".google.protobuf.Duration": schemaCore{
+ Type: "string",
+ },
+ ".google.protobuf.StringValue": schemaCore{
+ Type: "string",
+ },
+ ".google.protobuf.BytesValue": schemaCore{
+ Type: "string",
+ Format: "byte",
+ },
+ ".google.protobuf.Int32Value": schemaCore{
+ Type: "integer",
+ Format: "int32",
+ },
+ ".google.protobuf.UInt32Value": schemaCore{
+ Type: "integer",
+ Format: "int64",
+ },
+ ".google.protobuf.Int64Value": schemaCore{
+ Type: "string",
+ Format: "int64",
+ },
+ ".google.protobuf.UInt64Value": schemaCore{
+ Type: "string",
+ Format: "uint64",
+ },
+ ".google.protobuf.FloatValue": schemaCore{
+ Type: "number",
+ Format: "float",
+ },
+ ".google.protobuf.DoubleValue": schemaCore{
+ Type: "number",
+ Format: "double",
+ },
+ ".google.protobuf.BoolValue": schemaCore{
+ Type: "boolean",
+ Format: "boolean",
+ },
+ ".google.protobuf.Empty": schemaCore{},
+ ".google.protobuf.Struct": schemaCore{
+ Type: "object",
+ },
+ ".google.protobuf.Value": schemaCore{
+ Type: "object",
+ },
+ ".google.protobuf.ListValue": schemaCore{
+ Type: "array",
+ Items: (*swaggerItemsObject)(&schemaCore{
+ Type: "object",
+ }),
+ },
+ ".google.protobuf.NullValue": schemaCore{
+ Type: "string",
+ },
+}
+
+func listEnumNames(enum *descriptor.Enum) (names []string) {
+ for _, value := range enum.GetValue() {
+ names = append(names, value.GetName())
+ }
+ return names
+}
+
+func getEnumDefault(enum *descriptor.Enum) string {
+ for _, value := range enum.GetValue() {
+ if value.GetNumber() == 0 {
+ return value.GetName()
+ }
+ }
+ return ""
+}
+
+// messageToQueryParameters converts a message to a list of swagger query parameters.
+func messageToQueryParameters(message *descriptor.Message, reg *descriptor.Registry, pathParams []descriptor.Parameter) (params []swaggerParameterObject, err error) {
+ for _, field := range message.Fields {
+ p, err := queryParams(message, field, "", reg, pathParams)
+ if err != nil {
+ return nil, err
+ }
+ params = append(params, p...)
+ }
+ return params, nil
+}
+
+// queryParams converts a field to a list of swagger query parameters recursively.
+func queryParams(message *descriptor.Message, field *descriptor.Field, prefix string, reg *descriptor.Registry, pathParams []descriptor.Parameter) (params []swaggerParameterObject, err error) {
+ // make sure the parameter is not already listed as a path parameter
+ for _, pathParam := range pathParams {
+ if pathParam.Target == field {
+ return nil, nil
+ }
+ }
+ schema := schemaOfField(field, reg, nil)
+ fieldType := field.GetTypeName()
+ if message.File != nil {
+ comments := fieldProtoComments(reg, message, field)
+ if err := updateSwaggerDataFromComments(&schema, comments, false); err != nil {
+ return nil, err
+ }
+ }
+
+ isEnum := field.GetType() == pbdescriptor.FieldDescriptorProto_TYPE_ENUM
+ items := schema.Items
+ if schema.Type != "" || isEnum {
+ if schema.Type == "object" {
+ return nil, nil // TODO: currently, mapping object in query parameter is not supported
+ }
+ if items != nil && (items.Type == "" || items.Type == "object") && !isEnum {
+ return nil, nil // TODO: currently, mapping object in query parameter is not supported
+ }
+ desc := schema.Description
+ if schema.Title != "" { // merge title because title of parameter object will be ignored
+ desc = strings.TrimSpace(schema.Title + ". " + schema.Description)
+ }
+
+ // verify if the field is required
+ required := false
+ for _, fieldName := range schema.Required {
+ if fieldName == field.GetName() {
+ required = true
+ break
+ }
+ }
+
+ param := swaggerParameterObject{
+ Description: desc,
+ In: "query",
+ Default: schema.Default,
+ Type: schema.Type,
+ Items: schema.Items,
+ Format: schema.Format,
+ Required: required,
+ }
+ if param.Type == "array" {
+ param.CollectionFormat = "multi"
+ }
+
+ if reg.GetUseJSONNamesForFields() {
+ param.Name = prefix + field.GetJsonName()
+ } else {
+ param.Name = prefix + field.GetName()
+ }
+
+ if isEnum {
+ enum, err := reg.LookupEnum("", fieldType)
+ if err != nil {
+ return nil, fmt.Errorf("unknown enum type %s", fieldType)
+ }
+ if items != nil { // array
+ param.Items = &swaggerItemsObject{
+ Type: "string",
+ Enum: listEnumNames(enum),
+ }
+ } else {
+ param.Type = "string"
+ param.Enum = listEnumNames(enum)
+ param.Default = getEnumDefault(enum)
+ }
+ valueComments := enumValueProtoComments(reg, enum)
+ if valueComments != "" {
+ param.Description = strings.TrimLeft(param.Description+"\n\n "+valueComments, "\n")
+ }
+ }
+ return []swaggerParameterObject{param}, nil
+ }
+
+ // nested type, recurse
+ msg, err := reg.LookupMsg("", fieldType)
+ if err != nil {
+ return nil, fmt.Errorf("unknown message type %s", fieldType)
+ }
+ for _, nestedField := range msg.Fields {
+ p, err := queryParams(msg, nestedField, prefix+field.GetName()+".", reg, pathParams)
+ if err != nil {
+ return nil, err
+ }
+ params = append(params, p...)
+ }
+ return params, nil
+}
+
+// findServicesMessagesAndEnumerations discovers all messages and enums defined in the RPC methods of the service.
+func findServicesMessagesAndEnumerations(s []*descriptor.Service, reg *descriptor.Registry, m messageMap, ms messageMap, e enumMap, refs refMap) {
+ for _, svc := range s {
+ for _, meth := range svc.Methods {
+ // Request may be fully included in query
+ if _, ok := refs[fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg))]; ok {
+ if !skipRenderingRef(meth.RequestType.FQMN()) {
+ m[fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg)] = meth.RequestType
+ }
+ }
+ findNestedMessagesAndEnumerations(meth.RequestType, reg, m, e)
+
+ if !skipRenderingRef(meth.ResponseType.FQMN()) {
+ m[fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)] = meth.ResponseType
+ if meth.GetServerStreaming() {
+ runtimeStreamError := fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.StreamError", reg)
+ glog.V(1).Infof("StreamError FQMN: %s", runtimeStreamError)
+ streamError, err := reg.LookupMsg(".grpc.gateway.runtime", "StreamError")
+ if err == nil {
+ glog.V(1).Infof("StreamError: %v", streamError)
+ m[runtimeStreamError] = streamError
+ findNestedMessagesAndEnumerations(streamError, reg, m, e)
+ } else {
+ //just in case there is an error looking up StreamError
+ glog.Error(err)
+ }
+ ms[fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)] = meth.ResponseType
+ }
+ }
+ findNestedMessagesAndEnumerations(meth.ResponseType, reg, m, e)
+ }
+ }
+}
+
+// findNestedMessagesAndEnumerations those can be generated by the services.
+func findNestedMessagesAndEnumerations(message *descriptor.Message, reg *descriptor.Registry, m messageMap, e enumMap) {
+ // Iterate over all the fields that
+ for _, t := range message.Fields {
+ fieldType := t.GetTypeName()
+ // If the type is an empty string then it is a proto primitive
+ if fieldType != "" {
+ if _, ok := m[fieldType]; !ok {
+ msg, err := reg.LookupMsg("", fieldType)
+ if err != nil {
+ enum, err := reg.LookupEnum("", fieldType)
+ if err != nil {
+ panic(err)
+ }
+ e[fieldType] = enum
+ continue
+ }
+ m[fieldType] = msg
+ findNestedMessagesAndEnumerations(msg, reg, m, e)
+ }
+ }
+ }
+}
+
+func skipRenderingRef(refName string) bool {
+ _, ok := wktSchemas[refName]
+ return ok
+}
+
+func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject, reg *descriptor.Registry, customRefs refMap) {
+ for name, msg := range messages {
+ if skipRenderingRef(name) {
+ continue
+ }
+
+ if opt := msg.GetOptions(); opt != nil && opt.MapEntry != nil && *opt.MapEntry {
+ continue
+ }
+ schema := swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Type: "object",
+ },
+ }
+ msgComments := protoComments(reg, msg.File, msg.Outers, "MessageType", int32(msg.Index))
+ if err := updateSwaggerDataFromComments(&schema, msgComments, false); err != nil {
+ panic(err)
+ }
+ opts, err := extractSchemaOptionFromMessageDescriptor(msg.DescriptorProto)
+ if err != nil {
+ panic(err)
+ }
+ if opts != nil {
+ protoSchema := swaggerSchemaFromProtoSchema(opts, reg, customRefs)
+
+ // 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
+ schema.Minimum = protoSchema.Minimum
+ schema.ExclusiveMinimum = protoSchema.ExclusiveMinimum
+ schema.MaxLength = protoSchema.MaxLength
+ schema.MinLength = protoSchema.MinLength
+ schema.Pattern = protoSchema.Pattern
+ schema.Default = protoSchema.Default
+ schema.MaxItems = protoSchema.MaxItems
+ schema.MinItems = protoSchema.MinItems
+ schema.UniqueItems = protoSchema.UniqueItems
+ schema.MaxProperties = protoSchema.MaxProperties
+ schema.MinProperties = protoSchema.MinProperties
+ schema.Required = protoSchema.Required
+ if protoSchema.schemaCore.Type != "" || protoSchema.schemaCore.Ref != "" {
+ schema.schemaCore = protoSchema.schemaCore
+ }
+ if protoSchema.Title != "" {
+ schema.Title = protoSchema.Title
+ }
+ if protoSchema.Description != "" {
+ schema.Description = protoSchema.Description
+ }
+ if protoSchema.Example != nil {
+ schema.Example = protoSchema.Example
+ }
+ }
+
+ for _, f := range msg.Fields {
+ fieldValue := schemaOfField(f, reg, customRefs)
+ comments := fieldProtoComments(reg, msg, f)
+ if err := updateSwaggerDataFromComments(&fieldValue, comments, false); err != nil {
+ panic(err)
+ }
+
+ kv := keyVal{Value: fieldValue}
+ if reg.GetUseJSONNamesForFields() {
+ kv.Key = f.GetJsonName()
+ } else {
+ kv.Key = f.GetName()
+ }
+ if schema.Properties == nil {
+ schema.Properties = &swaggerSchemaObjectProperties{}
+ }
+ *schema.Properties = append(*schema.Properties, kv)
+ }
+ d[fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)] = schema
+ }
+}
+
+func renderMessagesAsStreamDefinition(messages messageMap, d swaggerDefinitionsObject, reg *descriptor.Registry) {
+ for name, msg := range messages {
+ if skipRenderingRef(name) {
+ continue
+ }
+
+ if opt := msg.GetOptions(); opt != nil && opt.MapEntry != nil && *opt.MapEntry {
+ continue
+ }
+ d[fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)] = swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Type: "object",
+ },
+ Title: fmt.Sprintf("Stream result of %s", fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)),
+ Properties: &swaggerSchemaObjectProperties{
+ keyVal{
+ Key: "result",
+ Value: swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Ref: fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)),
+ },
+ },
+ },
+ keyVal{
+ Key: "error",
+ Value: swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Ref: fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.StreamError", reg)),
+ },
+ },
+ },
+ },
+ }
+ }
+}
+
+// schemaOfField returns a swagger Schema Object for a protobuf field.
+func schemaOfField(f *descriptor.Field, reg *descriptor.Registry, refs refMap) swaggerSchemaObject {
+ const (
+ singular = 0
+ array = 1
+ object = 2
+ )
+ var (
+ core schemaCore
+ aggregate int
+ )
+
+ fd := f.FieldDescriptorProto
+ if m, err := reg.LookupMsg("", f.GetTypeName()); err == nil {
+ if opt := m.GetOptions(); opt != nil && opt.MapEntry != nil && *opt.MapEntry {
+ fd = m.GetField()[1]
+ aggregate = object
+ }
+ }
+ if fd.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED {
+ aggregate = array
+ }
+
+ var props *swaggerSchemaObjectProperties
+
+ switch ft := fd.GetType(); ft {
+ case pbdescriptor.FieldDescriptorProto_TYPE_ENUM, pbdescriptor.FieldDescriptorProto_TYPE_MESSAGE, pbdescriptor.FieldDescriptorProto_TYPE_GROUP:
+ if wktSchema, ok := wktSchemas[fd.GetTypeName()]; ok {
+ core = wktSchema
+
+ if fd.GetTypeName() == ".google.protobuf.Empty" {
+ props = &swaggerSchemaObjectProperties{}
+ }
+ } else {
+ core = schemaCore{
+ Ref: "#/definitions/" + fullyQualifiedNameToSwaggerName(fd.GetTypeName(), reg),
+ }
+ if refs != nil {
+ refs[fd.GetTypeName()] = struct{}{}
+
+ }
+ }
+ default:
+ ftype, format, ok := primitiveSchema(ft)
+ if ok {
+ core = schemaCore{Type: ftype, Format: format}
+ } else {
+ core = schemaCore{Type: ft.String(), Format: "UNKNOWN"}
+ }
+ }
+
+ ret := swaggerSchemaObject{}
+
+ switch aggregate {
+ case array:
+ ret = swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Type: "array",
+ Items: (*swaggerItemsObject)(&core),
+ },
+ }
+ case object:
+ ret = swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Type: "object",
+ },
+ AdditionalProperties: &swaggerSchemaObject{Properties: props, schemaCore: core},
+ }
+ default:
+ ret = swaggerSchemaObject{
+ schemaCore: core,
+ Properties: props,
+ }
+ }
+
+ if j, err := extractJSONSchemaFromFieldDescriptor(fd); err == nil {
+ updateSwaggerObjectFromJSONSchema(&ret, j)
+ }
+
+ return ret
+}
+
+// primitiveSchema returns a pair of "Type" and "Format" in JSON Schema for
+// the given primitive field type.
+// The last return parameter is true iff the field type is actually primitive.
+func primitiveSchema(t pbdescriptor.FieldDescriptorProto_Type) (ftype, format string, ok bool) {
+ switch t {
+ case pbdescriptor.FieldDescriptorProto_TYPE_DOUBLE:
+ return "number", "double", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_FLOAT:
+ return "number", "float", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_INT64:
+ return "string", "int64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_UINT64:
+ // 64bit integer types are marshaled as string in the default JSONPb marshaler.
+ // TODO(yugui) Add an option to declare 64bit integers as int64.
+ //
+ // NOTE: uint64 is not a predefined format of integer type in Swagger spec.
+ // So we cannot expect that uint64 is commonly supported by swagger processor.
+ return "string", "uint64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_INT32:
+ return "integer", "int32", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_FIXED64:
+ // Ditto.
+ return "string", "uint64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_FIXED32:
+ // Ditto.
+ return "integer", "int64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_BOOL:
+ return "boolean", "boolean", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_STRING:
+ // NOTE: in swagger specifition, format should be empty on string type
+ return "string", "", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_BYTES:
+ return "string", "byte", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_UINT32:
+ // Ditto.
+ return "integer", "int64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_SFIXED32:
+ return "integer", "int32", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_SFIXED64:
+ return "string", "int64", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_SINT32:
+ return "integer", "int32", true
+ case pbdescriptor.FieldDescriptorProto_TYPE_SINT64:
+ return "string", "int64", true
+ default:
+ return "", "", false
+ }
+}
+
+// renderEnumerationsAsDefinition inserts enums into the definitions object.
+func renderEnumerationsAsDefinition(enums enumMap, d swaggerDefinitionsObject, reg *descriptor.Registry) {
+ for _, enum := range enums {
+ enumComments := protoComments(reg, enum.File, enum.Outers, "EnumType", int32(enum.Index))
+
+ // it may be necessary to sort the result of the GetValue function.
+ enumNames := listEnumNames(enum)
+ defaultValue := getEnumDefault(enum)
+ valueComments := enumValueProtoComments(reg, enum)
+ if valueComments != "" {
+ enumComments = strings.TrimLeft(enumComments+"\n\n "+valueComments, "\n")
+ }
+ enumSchemaObject := swaggerSchemaObject{
+ schemaCore: schemaCore{
+ Type: "string",
+ Enum: enumNames,
+ Default: defaultValue,
+ },
+ }
+ if err := updateSwaggerDataFromComments(&enumSchemaObject, enumComments, false); err != nil {
+ panic(err)
+ }
+
+ d[fullyQualifiedNameToSwaggerName(enum.FQEN(), reg)] = enumSchemaObject
+ }
+}
+
+// Take in a FQMN or FQEN and return a swagger safe version of the FQMN
+func fullyQualifiedNameToSwaggerName(fqn string, reg *descriptor.Registry) string {
+ registriesSeenMutex.Lock()
+ defer registriesSeenMutex.Unlock()
+ if mapping, present := registriesSeen[reg]; present {
+ return mapping[fqn]
+ }
+ mapping := resolveFullyQualifiedNameToSwaggerNames(append(reg.GetAllFQMNs(), reg.GetAllFQENs()...), reg.GetUseFQNForSwaggerName())
+ registriesSeen[reg] = mapping
+ return mapping[fqn]
+}
+
+// registriesSeen is used to memoise calls to resolveFullyQualifiedNameToSwaggerNames so
+// we don't repeat it unnecessarily, since it can take some time.
+var registriesSeen = map[*descriptor.Registry]map[string]string{}
+var registriesSeenMutex sync.Mutex
+
+// Take the names of every proto and "uniq-ify" them. The idea is to produce a
+// set of names that meet a couple of conditions. They must be stable, they
+// must be unique, and they must be shorter than the FQN.
+//
+// This likely could be made better. This will always generate the same names
+// but may not always produce optimal names. This is a reasonably close
+// approximation of what they should look like in most cases.
+func resolveFullyQualifiedNameToSwaggerNames(messages []string, useFQNForSwaggerName bool) map[string]string {
+ packagesByDepth := make(map[int][][]string)
+ uniqueNames := make(map[string]string)
+
+ hierarchy := func(pkg string) []string {
+ return strings.Split(pkg, ".")
+ }
+
+ for _, p := range messages {
+ h := hierarchy(p)
+ for depth := range h {
+ if _, ok := packagesByDepth[depth]; !ok {
+ packagesByDepth[depth] = make([][]string, 0)
+ }
+ packagesByDepth[depth] = append(packagesByDepth[depth], h[len(h)-depth:])
+ }
+ }
+
+ count := func(list [][]string, item []string) int {
+ i := 0
+ for _, element := range list {
+ if reflect.DeepEqual(element, item) {
+ i++
+ }
+ }
+ return i
+ }
+
+ for _, p := range messages {
+ if useFQNForSwaggerName {
+ // strip leading dot from proto fqn
+ uniqueNames[p] = p[1:]
+ } else {
+ h := hierarchy(p)
+ for depth := 0; depth < len(h); depth++ {
+ if count(packagesByDepth[depth], h[len(h)-depth:]) == 1 {
+ uniqueNames[p] = strings.Join(h[len(h)-depth-1:], "")
+ break
+ }
+ if depth == len(h)-1 {
+ uniqueNames[p] = strings.Join(h, "")
+ }
+ }
+ }
+ }
+ return uniqueNames
+}
+
+var canRegexp = regexp.MustCompile("{([a-zA-Z][a-zA-Z0-9_.]*).*}")
+
+// Swagger expects paths of the form /path/{string_value} but grpc-gateway paths are expected to be of the form /path/{string_value=strprefix/*}. This should reformat it correctly.
+func templateToSwaggerPath(path string, reg *descriptor.Registry) string {
+ // It seems like the right thing to do here is to just use
+ // strings.Split(path, "/") but that breaks badly when you hit a url like
+ // /{my_field=prefix/*}/ and end up with 2 sections representing my_field.
+ // Instead do the right thing and write a small pushdown (counter) automata
+ // for it.
+ var parts []string
+ depth := 0
+ buffer := ""
+ jsonBuffer := ""
+ for _, char := range path {
+ switch char {
+ case '{':
+ // Push on the stack
+ depth++
+ buffer += string(char)
+ jsonBuffer = ""
+ jsonBuffer += string(char)
+ break
+ case '}':
+ if depth == 0 {
+ panic("Encountered } without matching { before it.")
+ }
+ // Pop from the stack
+ depth--
+ buffer += string(char)
+ if reg.GetUseJSONNamesForFields() &&
+ len(jsonBuffer) > 1 {
+ jsonSnakeCaseName := string(jsonBuffer[1:])
+ jsonCamelCaseName := string(lowerCamelCase(jsonSnakeCaseName))
+ prev := string(buffer[:len(buffer)-len(jsonSnakeCaseName)-2])
+ buffer = strings.Join([]string{prev, "{", jsonCamelCaseName, "}"}, "")
+ jsonBuffer = ""
+ }
+ case '/':
+ if depth == 0 {
+ parts = append(parts, buffer)
+ buffer = ""
+ // Since the stack was empty when we hit the '/' we are done with this
+ // section.
+ continue
+ }
+ buffer += string(char)
+ jsonBuffer += string(char)
+ default:
+ buffer += string(char)
+ jsonBuffer += string(char)
+ break
+ }
+ }
+
+ // Now append the last element to parts
+ parts = append(parts, buffer)
+
+ // Parts is now an array of segments of the path. Interestingly, since the
+ // syntax for this subsection CAN be handled by a regexp since it has no
+ // memory.
+ for index, part := range parts {
+ // If part is a resource name such as "parent", "name", "user.name", the format info must be retained.
+ prefix := canRegexp.ReplaceAllString(part, "$1")
+ if isResourceName(prefix) {
+ continue
+ }
+ parts[index] = canRegexp.ReplaceAllString(part, "{$1}")
+ }
+
+ return strings.Join(parts, "/")
+}
+
+func isResourceName(prefix string) bool {
+ words := strings.Split(prefix, ".")
+ l := len(words)
+ field := words[l-1]
+ words = strings.Split(field, ":")
+ field = words[0]
+ return field == "parent" || field == "name"
+}
+
+func renderServices(services []*descriptor.Service, paths swaggerPathsObject, reg *descriptor.Registry, requestResponseRefs, customRefs refMap) error {
+ // Correctness of svcIdx and methIdx depends on 'services' containing the services in the same order as the 'file.Service' array.
+ for svcIdx, svc := range services {
+ for methIdx, meth := range svc.Methods {
+ for bIdx, b := range meth.Bindings {
+ // Iterate over all the swagger parameters
+ parameters := swaggerParametersObject{}
+ for _, parameter := range b.PathParams {
+
+ var paramType, paramFormat, desc, collectionFormat, defaultValue string
+ var enumNames []string
+ var items *swaggerItemsObject
+ var minItems *int
+ switch pt := parameter.Target.GetType(); pt {
+ case pbdescriptor.FieldDescriptorProto_TYPE_GROUP, pbdescriptor.FieldDescriptorProto_TYPE_MESSAGE:
+ if descriptor.IsWellKnownType(parameter.Target.GetTypeName()) {
+ if parameter.IsRepeated() {
+ return fmt.Errorf("only primitive and enum types are allowed in repeated path parameters")
+ }
+ schema := schemaOfField(parameter.Target, reg, customRefs)
+ paramType = schema.Type
+ paramFormat = schema.Format
+ desc = schema.Description
+ defaultValue = schema.Default
+ } else {
+ return fmt.Errorf("only primitive and well-known types are allowed in path parameters")
+ }
+ case pbdescriptor.FieldDescriptorProto_TYPE_ENUM:
+ paramType = "string"
+ paramFormat = ""
+ enum, err := reg.LookupEnum("", parameter.Target.GetTypeName())
+ if err != nil {
+ return err
+ }
+ enumNames = listEnumNames(enum)
+ schema := schemaOfField(parameter.Target, reg, customRefs)
+ desc = schema.Description
+ defaultValue = schema.Default
+ default:
+ var ok bool
+ paramType, paramFormat, ok = primitiveSchema(pt)
+ if !ok {
+ return fmt.Errorf("unknown field type %v", pt)
+ }
+
+ schema := schemaOfField(parameter.Target, reg, customRefs)
+ desc = schema.Description
+ defaultValue = schema.Default
+ }
+
+ if parameter.IsRepeated() {
+ core := schemaCore{Type: paramType, Format: paramFormat}
+ if parameter.IsEnum() {
+ var s []string
+ core.Enum = enumNames
+ enumNames = s
+ }
+ items = (*swaggerItemsObject)(&core)
+ paramType = "array"
+ paramFormat = ""
+ collectionFormat = reg.GetRepeatedPathParamSeparatorName()
+ minItems = new(int)
+ *minItems = 1
+ }
+
+ if desc == "" {
+ desc = fieldProtoComments(reg, parameter.Target.Message, parameter.Target)
+ }
+ parameterString := parameter.String()
+ if reg.GetUseJSONNamesForFields() {
+ parameterString = lowerCamelCase(parameterString)
+ }
+ parameters = append(parameters, swaggerParameterObject{
+ Name: parameterString,
+ Description: desc,
+ In: "path",
+ Required: true,
+ Default: defaultValue,
+ // Parameters in gRPC-Gateway can only be strings?
+ Type: paramType,
+ Format: paramFormat,
+ Enum: enumNames,
+ Items: items,
+ CollectionFormat: collectionFormat,
+ MinItems: minItems,
+ })
+ }
+ // Now check if there is a body parameter
+ if b.Body != nil {
+ var schema swaggerSchemaObject
+ desc := ""
+
+ if len(b.Body.FieldPath) == 0 {
+ schema = swaggerSchemaObject{
+ schemaCore: schemaCore{},
+ }
+
+ wknSchemaCore, isWkn := wktSchemas[meth.RequestType.FQMN()]
+ if !isWkn {
+ schema.Ref = fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg))
+ } else {
+ schema.schemaCore = wknSchemaCore
+
+ // Special workaround for Empty: it's well-known type but wknSchemas only returns schema.schemaCore; but we need to set schema.Properties which is a level higher.
+ if meth.RequestType.FQMN() == ".google.protobuf.Empty" {
+ schema.Properties = &swaggerSchemaObjectProperties{}
+ }
+ }
+ } else {
+ lastField := b.Body.FieldPath[len(b.Body.FieldPath)-1]
+ schema = schemaOfField(lastField.Target, reg, customRefs)
+ if schema.Description != "" {
+ desc = schema.Description
+ } else {
+ desc = fieldProtoComments(reg, lastField.Target.Message, lastField.Target)
+ }
+ }
+
+ if meth.GetClientStreaming() {
+ desc += " (streaming inputs)"
+ }
+ parameters = append(parameters, swaggerParameterObject{
+ Name: "body",
+ Description: desc,
+ In: "body",
+ Required: true,
+ Schema: &schema,
+ })
+ } else if b.HTTPMethod == "GET" || b.HTTPMethod == "DELETE" {
+ // add the parameters to the query string
+ queryParams, err := messageToQueryParameters(meth.RequestType, reg, b.PathParams)
+ if err != nil {
+ return err
+ }
+ parameters = append(parameters, queryParams...)
+ }
+
+ pathItemObject, ok := paths[templateToSwaggerPath(b.PathTmpl.Template, reg)]
+ if !ok {
+ pathItemObject = swaggerPathItemObject{}
+ }
+
+ methProtoPath := protoPathIndex(reflect.TypeOf((*pbdescriptor.ServiceDescriptorProto)(nil)), "Method")
+ desc := "A successful response."
+ var responseSchema swaggerSchemaObject
+
+ if b.ResponseBody == nil || len(b.ResponseBody.FieldPath) == 0 {
+ responseSchema = swaggerSchemaObject{
+ schemaCore: schemaCore{},
+ }
+
+ // Don't link to a full definition for
+ // empty; it's overly verbose.
+ // schema.Properties{} renders it as
+ // well, without a definition
+ wknSchemaCore, isWkn := wktSchemas[meth.ResponseType.FQMN()]
+ if !isWkn {
+ responseSchema.Ref = fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg))
+ } else {
+ responseSchema.schemaCore = wknSchemaCore
+
+ // Special workaround for Empty: it's well-known type but wknSchemas only returns schema.schemaCore; but we need to set schema.Properties which is a level higher.
+ if meth.ResponseType.FQMN() == ".google.protobuf.Empty" {
+ responseSchema.Properties = &swaggerSchemaObjectProperties{}
+ }
+ }
+ } else {
+ // This is resolving the value of response_body in the google.api.HttpRule
+ lastField := b.ResponseBody.FieldPath[len(b.ResponseBody.FieldPath)-1]
+ responseSchema = schemaOfField(lastField.Target, reg, customRefs)
+ if responseSchema.Description != "" {
+ desc = responseSchema.Description
+ } else {
+ desc = fieldProtoComments(reg, lastField.Target.Message, lastField.Target)
+ }
+ }
+ if meth.GetServerStreaming() {
+ desc += "(streaming responses)"
+ // Use the streamdefinition which wraps the message in a "result"
+ responseSchema.Ref = strings.Replace(responseSchema.Ref, `#/definitions/`, `#/x-stream-definitions/`, 1)
+ }
+
+ tag := svc.GetName()
+ if pkg := svc.File.GetPackage(); pkg != "" && reg.IsIncludePackageInTags() {
+ tag = pkg + "." + tag
+ }
+
+ operationObject := &swaggerOperationObject{
+ Tags: []string{tag},
+ Parameters: parameters,
+ Responses: swaggerResponsesObject{
+ "200": swaggerResponseObject{
+ Description: desc,
+ Schema: responseSchema,
+ },
+ },
+ }
+ if bIdx == 0 {
+ operationObject.OperationID = fmt.Sprintf("%s", meth.GetName())
+ } else {
+ // OperationID must be unique in an OpenAPI v2 definition.
+ operationObject.OperationID = fmt.Sprintf("%s%d", meth.GetName(), bIdx+1)
+ }
+
+ // Fill reference map with referenced request messages
+ for _, param := range operationObject.Parameters {
+ if param.Schema != nil && param.Schema.Ref != "" {
+ requestResponseRefs[param.Schema.Ref] = struct{}{}
+ }
+ }
+
+ methComments := protoComments(reg, svc.File, nil, "Method", int32(svcIdx), methProtoPath, int32(methIdx))
+ if err := updateSwaggerDataFromComments(operationObject, methComments, false); err != nil {
+ panic(err)
+ }
+
+ opts, err := extractOperationOptionFromMethodDescriptor(meth.MethodDescriptorProto)
+ if opts != nil {
+ if err != nil {
+ panic(err)
+ }
+ operationObject.ExternalDocs = protoExternalDocumentationToSwaggerExternalDocumentation(opts.ExternalDocs)
+ // TODO(ivucica): this would be better supported by looking whether the method is deprecated in the proto file
+ operationObject.Deprecated = opts.Deprecated
+
+ if opts.Summary != "" {
+ operationObject.Summary = opts.Summary
+ }
+ if opts.Description != "" {
+ operationObject.Description = opts.Description
+ }
+ if len(opts.Tags) > 0 {
+ operationObject.Tags = make([]string, len(opts.Tags))
+ copy(operationObject.Tags, opts.Tags)
+ }
+ if opts.Security != nil {
+ newSecurity := []swaggerSecurityRequirementObject{}
+ if operationObject.Security != nil {
+ newSecurity = *operationObject.Security
+ }
+ for _, secReq := range opts.Security {
+ newSecReq := swaggerSecurityRequirementObject{}
+ for secReqKey, secReqValue := range secReq.SecurityRequirement {
+ if secReqValue == nil {
+ continue
+ }
+
+ newSecReqValue := make([]string, len(secReqValue.Scope))
+ copy(newSecReqValue, secReqValue.Scope)
+ newSecReq[secReqKey] = newSecReqValue
+ }
+
+ if len(newSecReq) > 0 {
+ newSecurity = append(newSecurity, newSecReq)
+ }
+ }
+ operationObject.Security = &newSecurity
+ }
+ if opts.Responses != nil {
+ for name, resp := range opts.Responses {
+ respObj := swaggerResponseObject{
+ Description: resp.Description,
+ Schema: swaggerSchemaFromProtoSchema(resp.Schema, reg, customRefs),
+ }
+ if resp.Extensions != nil {
+ exts, err := processExtensions(resp.Extensions)
+ if err != nil {
+ return err
+ }
+ respObj.extensions = exts
+ }
+ operationObject.Responses[name] = respObj
+ }
+ }
+
+ if opts.Extensions != nil {
+ exts, err := processExtensions(opts.Extensions)
+ if err != nil {
+ return err
+ }
+ operationObject.extensions = exts
+ }
+
+ // TODO(ivucica): add remaining fields of operation object
+ }
+
+ switch b.HTTPMethod {
+ case "DELETE":
+ pathItemObject.Delete = operationObject
+ break
+ case "GET":
+ pathItemObject.Get = operationObject
+ break
+ case "POST":
+ pathItemObject.Post = operationObject
+ break
+ case "PUT":
+ pathItemObject.Put = operationObject
+ break
+ case "PATCH":
+ pathItemObject.Patch = operationObject
+ break
+ }
+ paths[templateToSwaggerPath(b.PathTmpl.Template, reg)] = pathItemObject
+ }
+ }
+ }
+
+ // Success! return nil on the error object
+ return nil
+}
+
+// This function is called with a param which contains the entire definition of a method.
+func applyTemplate(p param) (*swaggerObject, error) {
+ // Create the basic template object. This is the object that everything is
+ // defined off of.
+ s := swaggerObject{
+ // Swagger 2.0 is the version of this document
+ Swagger: "2.0",
+ Schemes: []string{"http", "https"},
+ Consumes: []string{"application/json"},
+ Produces: []string{"application/json"},
+ Paths: make(swaggerPathsObject),
+ Definitions: make(swaggerDefinitionsObject),
+ StreamDefinitions: make(swaggerDefinitionsObject),
+ Info: swaggerInfoObject{
+ Title: *p.File.Name,
+ Version: "version not set",
+ },
+ }
+
+ // Loops through all the services and their exposed GET/POST/PUT/DELETE definitions
+ // and create entries for all of them.
+ // Also adds custom user specified references to second map.
+ requestResponseRefs, customRefs := refMap{}, refMap{}
+ if err := renderServices(p.Services, s.Paths, p.reg, requestResponseRefs, customRefs); err != nil {
+ panic(err)
+ }
+
+ // Find all the service's messages and enumerations that are defined (recursively)
+ // and write request, response and other custom (but referenced) types out as definition objects.
+ m := messageMap{}
+ ms := messageMap{}
+ e := enumMap{}
+ findServicesMessagesAndEnumerations(p.Services, p.reg, m, ms, e, requestResponseRefs)
+ renderMessagesAsDefinition(m, s.Definitions, p.reg, customRefs)
+ renderMessagesAsStreamDefinition(ms, s.StreamDefinitions, p.reg)
+ renderEnumerationsAsDefinition(e, s.Definitions, p.reg)
+
+ // File itself might have some comments and metadata.
+ packageProtoPath := protoPathIndex(reflect.TypeOf((*pbdescriptor.FileDescriptorProto)(nil)), "Package")
+ packageComments := protoComments(p.reg, p.File, nil, "Package", packageProtoPath)
+ if err := updateSwaggerDataFromComments(&s, packageComments, true); err != nil {
+ panic(err)
+ }
+
+ // There may be additional options in the swagger option in the proto.
+ spb, err := extractSwaggerOptionFromFileDescriptor(p.FileDescriptorProto)
+ if err != nil {
+ panic(err)
+ }
+ if spb != nil {
+ if spb.Swagger != "" {
+ s.Swagger = spb.Swagger
+ }
+ if spb.Info != nil {
+ if spb.Info.Title != "" {
+ s.Info.Title = spb.Info.Title
+ }
+ if spb.Info.Description != "" {
+ s.Info.Description = spb.Info.Description
+ }
+ if spb.Info.TermsOfService != "" {
+ s.Info.TermsOfService = spb.Info.TermsOfService
+ }
+ if spb.Info.Version != "" {
+ s.Info.Version = spb.Info.Version
+ }
+ if spb.Info.Contact != nil {
+ if s.Info.Contact == nil {
+ s.Info.Contact = &swaggerContactObject{}
+ }
+ if spb.Info.Contact.Name != "" {
+ s.Info.Contact.Name = spb.Info.Contact.Name
+ }
+ if spb.Info.Contact.Url != "" {
+ s.Info.Contact.URL = spb.Info.Contact.Url
+ }
+ if spb.Info.Contact.Email != "" {
+ s.Info.Contact.Email = spb.Info.Contact.Email
+ }
+ }
+ if spb.Info.License != nil {
+ if s.Info.License == nil {
+ s.Info.License = &swaggerLicenseObject{}
+ }
+ if spb.Info.License.Name != "" {
+ s.Info.License.Name = spb.Info.License.Name
+ }
+ if spb.Info.License.Url != "" {
+ s.Info.License.URL = spb.Info.License.Url
+ }
+ }
+ if spb.Info.Extensions != nil {
+ exts, err := processExtensions(spb.Info.Extensions)
+ if err != nil {
+ return nil, err
+ }
+ s.Info.extensions = exts
+ }
+ }
+ if spb.Host != "" {
+ s.Host = spb.Host
+ }
+ if spb.BasePath != "" {
+ s.BasePath = spb.BasePath
+ }
+ if len(spb.Schemes) > 0 {
+ s.Schemes = make([]string, len(spb.Schemes))
+ for i, scheme := range spb.Schemes {
+ s.Schemes[i] = strings.ToLower(scheme.String())
+ }
+ }
+ if len(spb.Consumes) > 0 {
+ s.Consumes = make([]string, len(spb.Consumes))
+ copy(s.Consumes, spb.Consumes)
+ }
+ if len(spb.Produces) > 0 {
+ s.Produces = make([]string, len(spb.Produces))
+ copy(s.Produces, spb.Produces)
+ }
+ if spb.SecurityDefinitions != nil && spb.SecurityDefinitions.Security != nil {
+ if s.SecurityDefinitions == nil {
+ s.SecurityDefinitions = swaggerSecurityDefinitionsObject{}
+ }
+ for secDefKey, secDefValue := range spb.SecurityDefinitions.Security {
+ var newSecDefValue swaggerSecuritySchemeObject
+ if oldSecDefValue, ok := s.SecurityDefinitions[secDefKey]; !ok {
+ newSecDefValue = swaggerSecuritySchemeObject{}
+ } else {
+ newSecDefValue = oldSecDefValue
+ }
+ if secDefValue.Type != swagger_options.SecurityScheme_TYPE_INVALID {
+ switch secDefValue.Type {
+ case swagger_options.SecurityScheme_TYPE_BASIC:
+ newSecDefValue.Type = "basic"
+ case swagger_options.SecurityScheme_TYPE_API_KEY:
+ newSecDefValue.Type = "apiKey"
+ case swagger_options.SecurityScheme_TYPE_OAUTH2:
+ newSecDefValue.Type = "oauth2"
+ }
+ }
+ if secDefValue.Description != "" {
+ newSecDefValue.Description = secDefValue.Description
+ }
+ if secDefValue.Name != "" {
+ newSecDefValue.Name = secDefValue.Name
+ }
+ if secDefValue.In != swagger_options.SecurityScheme_IN_INVALID {
+ switch secDefValue.In {
+ case swagger_options.SecurityScheme_IN_QUERY:
+ newSecDefValue.In = "query"
+ case swagger_options.SecurityScheme_IN_HEADER:
+ newSecDefValue.In = "header"
+ }
+ }
+ if secDefValue.Flow != swagger_options.SecurityScheme_FLOW_INVALID {
+ switch secDefValue.Flow {
+ case swagger_options.SecurityScheme_FLOW_IMPLICIT:
+ newSecDefValue.Flow = "implicit"
+ case swagger_options.SecurityScheme_FLOW_PASSWORD:
+ newSecDefValue.Flow = "password"
+ case swagger_options.SecurityScheme_FLOW_APPLICATION:
+ newSecDefValue.Flow = "application"
+ case swagger_options.SecurityScheme_FLOW_ACCESS_CODE:
+ newSecDefValue.Flow = "accessCode"
+ }
+ }
+ if secDefValue.AuthorizationUrl != "" {
+ newSecDefValue.AuthorizationURL = secDefValue.AuthorizationUrl
+ }
+ if secDefValue.TokenUrl != "" {
+ newSecDefValue.TokenURL = secDefValue.TokenUrl
+ }
+ if secDefValue.Scopes != nil {
+ if newSecDefValue.Scopes == nil {
+ newSecDefValue.Scopes = swaggerScopesObject{}
+ }
+ for scopeKey, scopeDesc := range secDefValue.Scopes.Scope {
+ newSecDefValue.Scopes[scopeKey] = scopeDesc
+ }
+ }
+ if secDefValue.Extensions != nil {
+ exts, err := processExtensions(secDefValue.Extensions)
+ if err != nil {
+ return nil, err
+ }
+ newSecDefValue.extensions = exts
+ }
+ s.SecurityDefinitions[secDefKey] = newSecDefValue
+ }
+ }
+ if spb.Security != nil {
+ newSecurity := []swaggerSecurityRequirementObject{}
+ if s.Security == nil {
+ newSecurity = []swaggerSecurityRequirementObject{}
+ } else {
+ newSecurity = s.Security
+ }
+ for _, secReq := range spb.Security {
+ newSecReq := swaggerSecurityRequirementObject{}
+ for secReqKey, secReqValue := range secReq.SecurityRequirement {
+ newSecReqValue := make([]string, len(secReqValue.Scope))
+ copy(newSecReqValue, secReqValue.Scope)
+ newSecReq[secReqKey] = newSecReqValue
+ }
+ newSecurity = append(newSecurity, newSecReq)
+ }
+ s.Security = newSecurity
+ }
+ s.ExternalDocs = protoExternalDocumentationToSwaggerExternalDocumentation(spb.ExternalDocs)
+ // Populate all Paths with Responses set at top level,
+ // preferring Responses already set over those at the top level.
+ if spb.Responses != nil {
+ for _, verbs := range s.Paths {
+ var maps []swaggerResponsesObject
+ if verbs.Delete != nil {
+ maps = append(maps, verbs.Delete.Responses)
+ }
+ if verbs.Get != nil {
+ maps = append(maps, verbs.Get.Responses)
+ }
+ if verbs.Post != nil {
+ maps = append(maps, verbs.Post.Responses)
+ }
+ if verbs.Put != nil {
+ maps = append(maps, verbs.Put.Responses)
+ }
+ if verbs.Patch != nil {
+ maps = append(maps, verbs.Patch.Responses)
+ }
+
+ for k, v := range spb.Responses {
+ for _, respMap := range maps {
+ if _, ok := respMap[k]; ok {
+ // Don't overwrite already existing Responses
+ continue
+ }
+ respMap[k] = swaggerResponseObject{
+ Description: v.Description,
+ Schema: swaggerSchemaFromProtoSchema(v.Schema, p.reg, customRefs),
+ }
+ }
+ }
+ }
+ }
+
+ if spb.Extensions != nil {
+ exts, err := processExtensions(spb.Extensions)
+ if err != nil {
+ return nil, err
+ }
+ s.extensions = exts
+ }
+
+ // Additional fields on the OpenAPI v2 spec's "Swagger" object
+ // should be added here, once supported in the proto.
+ }
+
+ // Finally add any references added by users that aren't
+ // otherwise rendered.
+ addCustomRefs(s.Definitions, p.reg, customRefs)
+
+ return &s, nil
+}
+
+func processExtensions(inputExts map[string]*structpb.Value) ([]extension, error) {
+ exts := []extension{}
+ for k, v := range inputExts {
+ if !strings.HasPrefix(k, "x-") {
+ return nil, fmt.Errorf("Extension keys need to start with \"x-\": %q", k)
+ }
+ ext, err := (&jsonpb.Marshaler{Indent: " "}).MarshalToString(v)
+ if err != nil {
+ return nil, err
+ }
+ exts = append(exts, extension{key: k, value: json.RawMessage(ext)})
+ }
+ sort.Slice(exts, func(i, j int) bool { return exts[i].key < exts[j].key })
+ return exts, nil
+}
+
+// updateSwaggerDataFromComments updates a Swagger object based on a comment
+// from the proto file.
+//
+// First paragraph of a comment is used for summary. Remaining paragraphs of
+// a comment are used for description. If 'Summary' field is not present on
+// the passed swaggerObject, the summary and description are joined by \n\n.
+//
+// If there is a field named 'Info', its 'Summary' and 'Description' fields
+// will be updated instead.
+//
+// If there is no 'Summary', the same behavior will be attempted on 'Title',
+// but only if the last character is not a period.
+func updateSwaggerDataFromComments(swaggerObject interface{}, comment string, isPackageObject bool) error {
+ if len(comment) == 0 {
+ return nil
+ }
+
+ // Figure out what to apply changes to.
+ swaggerObjectValue := reflect.ValueOf(swaggerObject)
+ infoObjectValue := swaggerObjectValue.Elem().FieldByName("Info")
+ if !infoObjectValue.CanSet() {
+ // No such field? Apply summary and description directly to
+ // passed object.
+ infoObjectValue = swaggerObjectValue.Elem()
+ }
+
+ // Figure out which properties to update.
+ summaryValue := infoObjectValue.FieldByName("Summary")
+ descriptionValue := infoObjectValue.FieldByName("Description")
+ readOnlyValue := infoObjectValue.FieldByName("ReadOnly")
+
+ if readOnlyValue.Kind() == reflect.Bool && readOnlyValue.CanSet() && strings.Contains(comment, "Output only.") {
+ readOnlyValue.Set(reflect.ValueOf(true))
+ }
+
+ usingTitle := false
+ if !summaryValue.CanSet() {
+ summaryValue = infoObjectValue.FieldByName("Title")
+ usingTitle = true
+ }
+
+ paragraphs := strings.Split(comment, "\n\n")
+
+ // If there is a summary (or summary-equivalent) and it's empty, use the first
+ // paragraph as summary, and the rest as description.
+ if summaryValue.CanSet() {
+ summary := strings.TrimSpace(paragraphs[0])
+ description := strings.TrimSpace(strings.Join(paragraphs[1:], "\n\n"))
+ if !usingTitle || (len(summary) > 0 && summary[len(summary)-1] != '.') {
+ // overrides the schema value only if it's empty
+ // keep the comment precedence when updating the package definition
+ if summaryValue.Len() == 0 || isPackageObject {
+ summaryValue.Set(reflect.ValueOf(summary))
+ }
+ if len(description) > 0 {
+ if !descriptionValue.CanSet() {
+ return fmt.Errorf("Encountered object type with a summary, but no description")
+ }
+ // overrides the schema value only if it's empty
+ // keep the comment precedence when updating the package definition
+ if descriptionValue.Len() == 0 || isPackageObject {
+ descriptionValue.Set(reflect.ValueOf(description))
+ }
+ }
+ return nil
+ }
+ }
+
+ // There was no summary field on the swaggerObject. Try to apply the
+ // whole comment into description if the swagger object description is empty.
+ if descriptionValue.CanSet() {
+ if descriptionValue.Len() == 0 || isPackageObject {
+ descriptionValue.Set(reflect.ValueOf(strings.Join(paragraphs, "\n\n")))
+ }
+ return nil
+ }
+
+ return fmt.Errorf("no description nor summary property")
+}
+
+func fieldProtoComments(reg *descriptor.Registry, msg *descriptor.Message, field *descriptor.Field) string {
+ protoPath := protoPathIndex(reflect.TypeOf((*pbdescriptor.DescriptorProto)(nil)), "Field")
+ for i, f := range msg.Fields {
+ if f == field {
+ return protoComments(reg, msg.File, msg.Outers, "MessageType", int32(msg.Index), protoPath, int32(i))
+ }
+ }
+ return ""
+}
+
+func enumValueProtoComments(reg *descriptor.Registry, enum *descriptor.Enum) string {
+ protoPath := protoPathIndex(reflect.TypeOf((*pbdescriptor.EnumDescriptorProto)(nil)), "Value")
+ var comments []string
+ for idx, value := range enum.GetValue() {
+ name := value.GetName()
+ str := protoComments(reg, enum.File, enum.Outers, "EnumType", int32(enum.Index), protoPath, int32(idx))
+ if str != "" {
+ comments = append(comments, name+": "+str)
+ }
+ }
+ if len(comments) > 0 {
+ return "- " + strings.Join(comments, "\n - ")
+ }
+ return ""
+}
+
+func protoComments(reg *descriptor.Registry, file *descriptor.File, outers []string, typeName string, typeIndex int32, fieldPaths ...int32) string {
+ if file.SourceCodeInfo == nil {
+ fmt.Fprintln(os.Stderr, "descriptor.File should not contain nil SourceCodeInfo")
+ return ""
+ }
+
+ outerPaths := make([]int32, len(outers))
+ for i := range outers {
+ location := ""
+ if file.Package != nil {
+ location = file.GetPackage()
+ }
+
+ msg, err := reg.LookupMsg(location, strings.Join(outers[:i+1], "."))
+ if err != nil {
+ panic(err)
+ }
+ outerPaths[i] = int32(msg.Index)
+ }
+
+ for _, loc := range file.SourceCodeInfo.Location {
+ if !isProtoPathMatches(loc.Path, outerPaths, typeName, typeIndex, fieldPaths) {
+ continue
+ }
+ comments := ""
+ if loc.LeadingComments != nil {
+ comments = strings.TrimRight(*loc.LeadingComments, "\n")
+ comments = strings.TrimSpace(comments)
+ // TODO(ivucica): this is a hack to fix "// " being interpreted as "//".
+ // perhaps we should:
+ // - split by \n
+ // - determine if every (but first and last) line begins with " "
+ // - trim every line only if that is the case
+ // - join by \n
+ comments = strings.Replace(comments, "\n ", "\n", -1)
+ }
+ return comments
+ }
+ return ""
+}
+
+var messageProtoPath = protoPathIndex(reflect.TypeOf((*pbdescriptor.FileDescriptorProto)(nil)), "MessageType")
+var nestedProtoPath = protoPathIndex(reflect.TypeOf((*pbdescriptor.DescriptorProto)(nil)), "NestedType")
+var packageProtoPath = protoPathIndex(reflect.TypeOf((*pbdescriptor.FileDescriptorProto)(nil)), "Package")
+var serviceProtoPath = protoPathIndex(reflect.TypeOf((*pbdescriptor.FileDescriptorProto)(nil)), "Service")
+var methodProtoPath = protoPathIndex(reflect.TypeOf((*pbdescriptor.ServiceDescriptorProto)(nil)), "Method")
+
+func isProtoPathMatches(paths []int32, outerPaths []int32, typeName string, typeIndex int32, fieldPaths []int32) bool {
+ if typeName == "Package" && typeIndex == packageProtoPath {
+ // path for package comments is just [2], and all the other processing
+ // is too complex for it.
+ if len(paths) == 0 || typeIndex != paths[0] {
+ return false
+ }
+ return true
+ }
+
+ if len(paths) != len(outerPaths)*2+2+len(fieldPaths) {
+ return false
+ }
+
+ if typeName == "Method" {
+ if paths[0] != serviceProtoPath || paths[2] != methodProtoPath {
+ return false
+ }
+ paths = paths[2:]
+ } else {
+ typeNameDescriptor := reflect.TypeOf((*pbdescriptor.FileDescriptorProto)(nil))
+
+ if len(outerPaths) > 0 {
+ if paths[0] != messageProtoPath || paths[1] != outerPaths[0] {
+ return false
+ }
+ paths = paths[2:]
+ outerPaths = outerPaths[1:]
+
+ for i, v := range outerPaths {
+ if paths[i*2] != nestedProtoPath || paths[i*2+1] != v {
+ return false
+ }
+ }
+ paths = paths[len(outerPaths)*2:]
+
+ if typeName == "MessageType" {
+ typeName = "NestedType"
+ }
+ typeNameDescriptor = reflect.TypeOf((*pbdescriptor.DescriptorProto)(nil))
+ }
+
+ if paths[0] != protoPathIndex(typeNameDescriptor, typeName) || paths[1] != typeIndex {
+ return false
+ }
+ paths = paths[2:]
+ }
+
+ for i, v := range fieldPaths {
+ if paths[i] != v {
+ return false
+ }
+ }
+ return true
+}
+
+// protoPathIndex returns a path component for google.protobuf.descriptor.SourceCode_Location.
+//
+// Specifically, it returns an id as generated from descriptor proto which
+// can be used to determine what type the id following it in the path is.
+// For example, if we are trying to locate comments related to a field named
+// `Address` in a message named `Person`, the path will be:
+//
+// [4, a, 2, b]
+//
+// While `a` gets determined by the order in which the messages appear in
+// the proto file, and `b` is the field index specified in the proto
+// file itself, the path actually needs to specify that `a` refers to a
+// message and not, say, a service; and that `b` refers to a field and not
+// an option.
+//
+// protoPathIndex figures out the values 4 and 2 in the above example. Because
+// messages are top level objects, the value of 4 comes from field id for
+// `MessageType` inside `google.protobuf.descriptor.FileDescriptor` message.
+// This field has a message type `google.protobuf.descriptor.DescriptorProto`.
+// And inside message `DescriptorProto`, there is a field named `Field` with id
+// 2.
+//
+// Some code generators seem to be hardcoding these values; this method instead
+// interprets them from `descriptor.proto`-derived Go source as necessary.
+func protoPathIndex(descriptorType reflect.Type, what string) int32 {
+ field, ok := descriptorType.Elem().FieldByName(what)
+ if !ok {
+ panic(fmt.Errorf("could not find protobuf descriptor type id for %s", what))
+ }
+ pbtag := field.Tag.Get("protobuf")
+ if pbtag == "" {
+ panic(fmt.Errorf("no Go tag 'protobuf' on protobuf descriptor for %s", what))
+ }
+ path, err := strconv.Atoi(strings.Split(pbtag, ",")[1])
+ if err != nil {
+ panic(fmt.Errorf("protobuf descriptor id for %s cannot be converted to a number: %s", what, err.Error()))
+ }
+
+ return int32(path)
+}
+
+// extractOperationOptionFromMethodDescriptor extracts the message of type
+// swagger_options.Operation from a given proto method's descriptor.
+func extractOperationOptionFromMethodDescriptor(meth *pbdescriptor.MethodDescriptorProto) (*swagger_options.Operation, error) {
+ if meth.Options == nil {
+ return nil, nil
+ }
+ if !proto.HasExtension(meth.Options, swagger_options.E_Openapiv2Operation) {
+ return nil, nil
+ }
+ ext, err := proto.GetExtension(meth.Options, swagger_options.E_Openapiv2Operation)
+ if err != nil {
+ return nil, err
+ }
+ opts, ok := ext.(*swagger_options.Operation)
+ if !ok {
+ return nil, fmt.Errorf("extension is %T; want an Operation", ext)
+ }
+ return opts, nil
+}
+
+// extractSchemaOptionFromMessageDescriptor extracts the message of type
+// swagger_options.Schema from a given proto message's descriptor.
+func extractSchemaOptionFromMessageDescriptor(msg *pbdescriptor.DescriptorProto) (*swagger_options.Schema, error) {
+ if msg.Options == nil {
+ return nil, nil
+ }
+ if !proto.HasExtension(msg.Options, swagger_options.E_Openapiv2Schema) {
+ return nil, nil
+ }
+ ext, err := proto.GetExtension(msg.Options, swagger_options.E_Openapiv2Schema)
+ if err != nil {
+ return nil, err
+ }
+ opts, ok := ext.(*swagger_options.Schema)
+ if !ok {
+ return nil, fmt.Errorf("extension is %T; want a Schema", ext)
+ }
+ return opts, nil
+}
+
+// extractSwaggerOptionFromFileDescriptor extracts the message of type
+// swagger_options.Swagger from a given proto method's descriptor.
+func extractSwaggerOptionFromFileDescriptor(file *pbdescriptor.FileDescriptorProto) (*swagger_options.Swagger, error) {
+ if file.Options == nil {
+ return nil, nil
+ }
+ if !proto.HasExtension(file.Options, swagger_options.E_Openapiv2Swagger) {
+ return nil, nil
+ }
+ ext, err := proto.GetExtension(file.Options, swagger_options.E_Openapiv2Swagger)
+ if err != nil {
+ return nil, err
+ }
+ opts, ok := ext.(*swagger_options.Swagger)
+ if !ok {
+ return nil, fmt.Errorf("extension is %T; want a Swagger object", ext)
+ }
+ return opts, nil
+}
+
+func extractJSONSchemaFromFieldDescriptor(fd *pbdescriptor.FieldDescriptorProto) (*swagger_options.JSONSchema, error) {
+ if fd.Options == nil {
+ return nil, nil
+ }
+ if !proto.HasExtension(fd.Options, swagger_options.E_Openapiv2Field) {
+ return nil, nil
+ }
+ ext, err := proto.GetExtension(fd.Options, swagger_options.E_Openapiv2Field)
+ if err != nil {
+ return nil, err
+ }
+ opts, ok := ext.(*swagger_options.JSONSchema)
+ if !ok {
+ return nil, fmt.Errorf("extension is %T; want a JSONSchema object", ext)
+ }
+ return opts, nil
+}
+
+func protoJSONSchemaToSwaggerSchemaCore(j *swagger_options.JSONSchema, reg *descriptor.Registry, refs refMap) schemaCore {
+ ret := schemaCore{}
+
+ if j.GetRef() != "" {
+ swaggerName := fullyQualifiedNameToSwaggerName(j.GetRef(), reg)
+ if swaggerName != "" {
+ ret.Ref = "#/definitions/" + swaggerName
+ if refs != nil {
+ refs[j.GetRef()] = struct{}{}
+ }
+ } else {
+ ret.Ref += j.GetRef()
+ }
+ } else {
+ f, t := protoJSONSchemaTypeToFormat(j.GetType())
+ ret.Format = f
+ ret.Type = t
+ }
+
+ return ret
+}
+
+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()
+ s.Minimum = j.GetMinimum()
+ s.ExclusiveMinimum = j.GetExclusiveMinimum()
+ s.MaxLength = j.GetMaxLength()
+ s.MinLength = j.GetMinLength()
+ s.Pattern = j.GetPattern()
+ s.Default = j.GetDefault()
+ s.MaxItems = j.GetMaxItems()
+ s.MinItems = j.GetMinItems()
+ s.UniqueItems = j.GetUniqueItems()
+ s.MaxProperties = j.GetMaxProperties()
+ s.MinProperties = j.GetMinProperties()
+ s.Required = j.GetRequired()
+ if overrideType := j.GetType(); len(overrideType) > 0 {
+ s.Type = strings.ToLower(overrideType[0].String())
+ }
+}
+
+func swaggerSchemaFromProtoSchema(s *swagger_options.Schema, reg *descriptor.Registry, refs refMap) swaggerSchemaObject {
+ ret := swaggerSchemaObject{
+ ExternalDocs: protoExternalDocumentationToSwaggerExternalDocumentation(s.GetExternalDocs()),
+ }
+
+ 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
+}
+
+func protoJSONSchemaTypeToFormat(in []swagger_options.JSONSchema_JSONSchemaSimpleTypes) (string, string) {
+ if len(in) == 0 {
+ return "", ""
+ }
+
+ // Can't support more than 1 type, just return the first element.
+ // This is due to an inconsistency in the design of the openapiv2 proto
+ // and that used in schemaCore. schemaCore uses the v3 definition of types,
+ // which only allows a single string, while the openapiv2 proto uses the OpenAPI v2
+ // definition, which defers to the JSON schema definition, which allows a string or an array.
+ // Sources:
+ // https://swagger.io/specification/#itemsObject
+ // https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.2
+ switch in[0] {
+ case swagger_options.JSONSchema_UNKNOWN, swagger_options.JSONSchema_NULL:
+ return "", ""
+ case swagger_options.JSONSchema_OBJECT:
+ return "object", ""
+ case swagger_options.JSONSchema_ARRAY:
+ return "array", ""
+ case swagger_options.JSONSchema_BOOLEAN:
+ return "boolean", "boolean"
+ case swagger_options.JSONSchema_INTEGER:
+ return "integer", "int32"
+ case swagger_options.JSONSchema_NUMBER:
+ return "number", "double"
+ case swagger_options.JSONSchema_STRING:
+ // NOTE: in swagger specifition, format should be empty on string type
+ return "string", ""
+ default:
+ // Maybe panic?
+ return "", ""
+ }
+}
+
+func protoExternalDocumentationToSwaggerExternalDocumentation(in *swagger_options.ExternalDocumentation) *swaggerExternalDocumentationObject {
+ if in == nil {
+ return nil
+ }
+
+ return &swaggerExternalDocumentationObject{
+ Description: in.Description,
+ URL: in.Url,
+ }
+}
+
+func addCustomRefs(d swaggerDefinitionsObject, reg *descriptor.Registry, refs refMap) {
+ if len(refs) == 0 {
+ return
+ }
+ msgMap := make(messageMap)
+ enumMap := make(enumMap)
+ for ref := range refs {
+ if _, ok := d[fullyQualifiedNameToSwaggerName(ref, reg)]; ok {
+ // Skip already existing definitions
+ delete(refs, ref)
+ continue
+ }
+ msg, err := reg.LookupMsg("", ref)
+ if err == nil {
+ msgMap[fullyQualifiedNameToSwaggerName(ref, reg)] = msg
+ continue
+ }
+ enum, err := reg.LookupEnum("", ref)
+ if err == nil {
+ enumMap[fullyQualifiedNameToSwaggerName(ref, reg)] = enum
+ continue
+ }
+
+ // ?? Should be either enum or msg
+ }
+ renderMessagesAsDefinition(msgMap, d, reg, refs)
+ renderEnumerationsAsDefinition(enumMap, d, reg)
+
+ // Run again in case any new refs were added
+ addCustomRefs(d, reg, refs)
+}
+
+func lowerCamelCase(parameter string) string {
+ parameterString := gogen.CamelCase(parameter)
+ builder := &strings.Builder{}
+ builder.WriteString(strings.ToLower(string(parameterString[0])))
+ builder.WriteString(parameterString[1:])
+ return builder.String()
+}
diff --git a/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/types.go b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/types.go
new file mode 100644
index 0000000..77db96d
--- /dev/null
+++ b/vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/genswagger/types.go
@@ -0,0 +1,254 @@
+package genswagger
+
+import (
+ "bytes"
+ "encoding/json"
+
+ "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
+)
+
+type param struct {
+ *descriptor.File
+ reg *descriptor.Registry
+}
+
+type binding struct {
+ *descriptor.Binding
+}
+
+// http://swagger.io/specification/#infoObject
+type swaggerInfoObject struct {
+ Title string `json:"title"`
+ Description string `json:"description,omitempty"`
+ TermsOfService string `json:"termsOfService,omitempty"`
+ Version string `json:"version"`
+
+ Contact *swaggerContactObject `json:"contact,omitempty"`
+ License *swaggerLicenseObject `json:"license,omitempty"`
+
+ extensions []extension
+}
+
+// http://swagger.io/specification/#contactObject
+type swaggerContactObject struct {
+ Name string `json:"name,omitempty"`
+ URL string `json:"url,omitempty"`
+ Email string `json:"email,omitempty"`
+}
+
+// http://swagger.io/specification/#licenseObject
+type swaggerLicenseObject struct {
+ Name string `json:"name,omitempty"`
+ URL string `json:"url,omitempty"`
+}
+
+// http://swagger.io/specification/#externalDocumentationObject
+type swaggerExternalDocumentationObject struct {
+ Description string `json:"description,omitempty"`
+ URL string `json:"url,omitempty"`
+}
+
+type extension struct {
+ key string
+ value json.RawMessage
+}
+
+// http://swagger.io/specification/#swaggerObject
+type swaggerObject struct {
+ Swagger string `json:"swagger"`
+ Info swaggerInfoObject `json:"info"`
+ Host string `json:"host,omitempty"`
+ BasePath string `json:"basePath,omitempty"`
+ Schemes []string `json:"schemes"`
+ Consumes []string `json:"consumes"`
+ Produces []string `json:"produces"`
+ Paths swaggerPathsObject `json:"paths"`
+ Definitions swaggerDefinitionsObject `json:"definitions"`
+ StreamDefinitions swaggerDefinitionsObject `json:"x-stream-definitions,omitempty"`
+ SecurityDefinitions swaggerSecurityDefinitionsObject `json:"securityDefinitions,omitempty"`
+ Security []swaggerSecurityRequirementObject `json:"security,omitempty"`
+ ExternalDocs *swaggerExternalDocumentationObject `json:"externalDocs,omitempty"`
+
+ extensions []extension
+}
+
+// http://swagger.io/specification/#securityDefinitionsObject
+type swaggerSecurityDefinitionsObject map[string]swaggerSecuritySchemeObject
+
+// http://swagger.io/specification/#securitySchemeObject
+type swaggerSecuritySchemeObject struct {
+ Type string `json:"type"`
+ Description string `json:"description,omitempty"`
+ Name string `json:"name,omitempty"`
+ In string `json:"in,omitempty"`
+ Flow string `json:"flow,omitempty"`
+ AuthorizationURL string `json:"authorizationUrl,omitempty"`
+ TokenURL string `json:"tokenUrl,omitempty"`
+ Scopes swaggerScopesObject `json:"scopes,omitempty"`
+
+ extensions []extension
+}
+
+// http://swagger.io/specification/#scopesObject
+type swaggerScopesObject map[string]string
+
+// http://swagger.io/specification/#securityRequirementObject
+type swaggerSecurityRequirementObject map[string][]string
+
+// http://swagger.io/specification/#pathsObject
+type swaggerPathsObject map[string]swaggerPathItemObject
+
+// http://swagger.io/specification/#pathItemObject
+type swaggerPathItemObject struct {
+ Get *swaggerOperationObject `json:"get,omitempty"`
+ Delete *swaggerOperationObject `json:"delete,omitempty"`
+ Post *swaggerOperationObject `json:"post,omitempty"`
+ Put *swaggerOperationObject `json:"put,omitempty"`
+ Patch *swaggerOperationObject `json:"patch,omitempty"`
+}
+
+// http://swagger.io/specification/#operationObject
+type swaggerOperationObject struct {
+ Summary string `json:"summary,omitempty"`
+ Description string `json:"description,omitempty"`
+ OperationID string `json:"operationId"`
+ Responses swaggerResponsesObject `json:"responses"`
+ Parameters swaggerParametersObject `json:"parameters,omitempty"`
+ Tags []string `json:"tags,omitempty"`
+ Deprecated bool `json:"deprecated,omitempty"`
+
+ Security *[]swaggerSecurityRequirementObject `json:"security,omitempty"`
+ ExternalDocs *swaggerExternalDocumentationObject `json:"externalDocs,omitempty"`
+
+ extensions []extension
+}
+
+type swaggerParametersObject []swaggerParameterObject
+
+// http://swagger.io/specification/#parameterObject
+type swaggerParameterObject struct {
+ Name string `json:"name"`
+ Description string `json:"description,omitempty"`
+ In string `json:"in,omitempty"`
+ Required bool `json:"required"`
+ Type string `json:"type,omitempty"`
+ Format string `json:"format,omitempty"`
+ Items *swaggerItemsObject `json:"items,omitempty"`
+ Enum []string `json:"enum,omitempty"`
+ CollectionFormat string `json:"collectionFormat,omitempty"`
+ Default string `json:"default,omitempty"`
+ MinItems *int `json:"minItems,omitempty"`
+
+ // Or you can explicitly refer to another type. If this is defined all
+ // other fields should be empty
+ Schema *swaggerSchemaObject `json:"schema,omitempty"`
+}
+
+// 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"`
+ Example json.RawMessage `json:"example,omitempty"`
+
+ Items *swaggerItemsObject `json:"items,omitempty"`
+
+ // If the item is an enumeration include a list of all the *NAMES* of the
+ // enum values. I'm not sure how well this will work but assuming all enums
+ // start from 0 index it will be great. I don't think that is a good assumption.
+ Enum []string `json:"enum,omitempty"`
+ Default string `json:"default,omitempty"`
+}
+
+type swaggerItemsObject schemaCore
+
+// http://swagger.io/specification/#responsesObject
+type swaggerResponsesObject map[string]swaggerResponseObject
+
+// http://swagger.io/specification/#responseObject
+type swaggerResponseObject struct {
+ Description string `json:"description"`
+ Schema swaggerSchemaObject `json:"schema"`
+
+ extensions []extension
+}
+
+type keyVal struct {
+ Key string
+ Value interface{}
+}
+
+type swaggerSchemaObjectProperties []keyVal
+
+func (op swaggerSchemaObjectProperties) MarshalJSON() ([]byte, error) {
+ var buf bytes.Buffer
+ buf.WriteString("{")
+ for i, kv := range op {
+ if i != 0 {
+ buf.WriteString(",")
+ }
+ key, err := json.Marshal(kv.Key)
+ if err != nil {
+ return nil, err
+ }
+ buf.Write(key)
+ buf.WriteString(":")
+ val, err := json.Marshal(kv.Value)
+ if err != nil {
+ return nil, err
+ }
+ buf.Write(val)
+ }
+
+ buf.WriteString("}")
+ return buf.Bytes(), nil
+}
+
+// http://swagger.io/specification/#schemaObject
+type swaggerSchemaObject struct {
+ schemaCore
+ // Properties can be recursively defined
+ Properties *swaggerSchemaObjectProperties `json:"properties,omitempty"`
+ AdditionalProperties *swaggerSchemaObject `json:"additionalProperties,omitempty"`
+
+ Description string `json:"description,omitempty"`
+ Title string `json:"title,omitempty"`
+
+ 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"`
+ Minimum float64 `json:"minimum,omitempty"`
+ ExclusiveMinimum bool `json:"exclusiveMinimum,omitempty"`
+ MaxLength uint64 `json:"maxLength,omitempty"`
+ MinLength uint64 `json:"minLength,omitempty"`
+ Pattern string `json:"pattern,omitempty"`
+ MaxItems uint64 `json:"maxItems,omitempty"`
+ MinItems uint64 `json:"minItems,omitempty"`
+ UniqueItems bool `json:"uniqueItems,omitempty"`
+ MaxProperties uint64 `json:"maxProperties,omitempty"`
+ MinProperties uint64 `json:"minProperties,omitempty"`
+ Required []string `json:"required,omitempty"`
+}
+
+// http://swagger.io/specification/#referenceObject
+type swaggerReferenceObject struct {
+ Ref string `json:"$ref"`
+}
+
+// http://swagger.io/specification/#definitionsObject
+type swaggerDefinitionsObject map[string]swaggerSchemaObject
+
+// Internal type mapping from FQMN to descriptor.Message. Used as a set by the
+// findServiceMessages function.
+type messageMap map[string]*descriptor.Message
+
+// Internal type mapping from FQEN to descriptor.Enum. Used as a set by the
+// findServiceMessages function.
+type enumMap map[string]*descriptor.Enum
+
+// Internal type to store used references.
+type refMap map[string]struct{}