Protocol Documentation

Table of Contents

{{.Name}}
- M{{.LongName}}
- E{{.LongName}}
- XFile-level Extensions
- S{{.Name}}
Scalar Value Types

{{range .Files}} {{$file_name := .Name}}

{{.Name}}

Top

{{p .Description}} {{range .Messages}}

{{.LongName}}

{{p .Description}} {{if .HasFields}} {{range .Fields}} {{end}}

Field	Type	Label	Description
{{.Name}}	{{.LongType}}	{{.Label}}	{{if (index .Options "deprecated"\|default false)}}Deprecated. {{end}}{{.Description}} {{if .DefaultValue}}Default: {{.DefaultValue}}{{end}}

{{$message := .}} {{- range .FieldOptions}} {{$option := .}} {{if eq . "validator.field" "validate.rules" }}

Validated Fields

{{range $message.FieldsWithOption .}} {{end}}

Field	Validations
{{.Name}}	{{range (.Option $option).Rules}} {{.Name}}: {{.Value}} {{end}}

{{else}}

Fields with {{.}} option

{{range $message.FieldsWithOption .}} {{end}}

Name	Option
{{.Name}}	{{ printf "%+v" (.Option $option)}}

{{end}} {{end -}} {{end}} {{if .HasExtensions}}
{{range .Extensions}} {{end}}

Extension	Type	Base	Number	Description
{{.Name}}	{{.LongType}}	{{.ContainingLongType}}	{{.Number}}	{{.Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}

{{end}} {{end}} {{range .Enums}}

{{.LongName}}

{{p .Description}} {{range .Values}} {{end}}

Name	Number	Description
{{.Name}}	{{.Number}}	{{.Description}}

{{end}} {{if .HasExtensions}}

File-level Extensions

{{range .Extensions}} {{end}}

Extension	Type	Base	Number	Description
{{.Name}}	{{.LongType}}	{{.ContainingLongType}}	{{.Number}}	{{.Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}

{{end}} {{range .Services}}

{{.Name}}

{{p .Description}} {{range .Methods}} {{end}}

Method Name	Request Type	Response Type	Description
{{.Name}}	{{.RequestLongType}}{{if .RequestStreaming}} stream{{end}}	{{.ResponseLongType}}{{if .ResponseStreaming}} stream{{end}}	{{.Description}}

{{$service := .}} {{- range .MethodOptions}} {{$option := .}} {{if eq . "google.api.http"}}

Methods with HTTP bindings

{{range $service.MethodsWithOption .}} {{$name := .Name}} {{range (.Option $option).Rules}} {{end}} {{end}}

Method Name	Method	Pattern	Body
{{$name}}	{{.Method}}	{{.Pattern}}	{{.Body}}

{{else}}

Methods with {{.}} option

{{range $service.MethodsWithOption .}} {{end}}

Method Name	Option
{{.Name}}	{{ printf "%+v" (.Option $option)}}

{{end}} {{end -}} {{end}} {{end}}

Scalar Value Types

{{range .Scalars}} {{end}}

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
{{.ProtoType}}	{{.Notes}}	{{.CppType}}	{{.JavaType}}	{{.PythonType}}	{{.GoType}}	{{.CSharp}}	{{.PhpType}}	{{.RubyType}}