9456a4e922
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
107 lines
3.4 KiB
Cheetah
107 lines
3.4 KiB
Cheetah
<!-- This file is automatically generated. DO NOT EDIT! -->
|
|
<!-- Needed because of https://github.com/pseudomuto/protoc-gen-doc/issues/274 -->
|
|
|
|
# Protocol Documentation
|
|
<a name="top"></a>
|
|
|
|
## Table of Contents
|
|
{{range .Files}}
|
|
{{$file_name := .Name}}- [{{.Name}}](#{{.Name | anchor}})
|
|
{{- if .Messages }}
|
|
{{range .Messages}} - [{{.LongName}}](#{{.FullName | anchor}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Enums }}
|
|
{{range .Enums}} - [{{.LongName}}](#{{.FullName | anchor}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Extensions }}
|
|
{{range .Extensions}} - [File-level Extensions](#{{$file_name | anchor}}-extensions)
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Services }}
|
|
{{range .Services}} - [{{.Name}}](#{{.FullName | anchor}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{end}}
|
|
- [Scalar Value Types](#scalar-value-types)
|
|
|
|
{{range .Files}}
|
|
{{$file_name := .Name}}
|
|
<a name="{{.Name | anchor}}"></a>
|
|
<p align="right"><a href="#top">Top</a></p>
|
|
|
|
## {{.Name}}
|
|
{{.Description}}
|
|
|
|
{{range .Messages}}
|
|
<a name="{{.FullName | anchor}}"></a>
|
|
|
|
### {{.LongName}}
|
|
{{.Description}}
|
|
|
|
{{if .HasFields}}
|
|
| Field | Type | Label | Description |
|
|
| ----- | ---- | ----- | ----------- |
|
|
{{range .Fields -}}
|
|
| {{.Name}} | [{{.LongType}}](#{{.FullType | anchor}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{.Description | replace "\n" "<br/>" | nobr}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{if .HasExtensions}}
|
|
| Extension | Type | Base | Number | Description |
|
|
| --------- | ---- | ---- | ------ | ----------- |
|
|
{{range .Extensions -}}
|
|
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{.Description | replace "\n" "<br/>" | nobr}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{end}}<!-- end messages -->
|
|
|
|
{{range .Enums}}
|
|
<a name="{{.FullName | anchor}}"></a>
|
|
|
|
### {{.LongName}}
|
|
{{.Description}}
|
|
|
|
| Name | Number | Description |
|
|
| ---- | ------ | ----------- |
|
|
{{range .Values -}}
|
|
| {{.Name}} | {{.Number}} | {{.Description | replace "\n" "<br/>" | nobr}} |
|
|
{{end}}
|
|
|
|
{{end}}<!-- end enums -->
|
|
|
|
{{if .HasExtensions}}
|
|
<a name="{{$file_name | anchor}}-extensions"></a>
|
|
|
|
### File-level Extensions
|
|
| Extension | Type | Base | Number | Description |
|
|
| --------- | ---- | ---- | ------ | ----------- |
|
|
{{range .Extensions -}}
|
|
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{.Description | replace "\n" "<br/>" | nobr}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
|
|
{{end}}
|
|
{{end}}<!-- end HasExtensions -->
|
|
|
|
{{range .Services}}
|
|
<a name="{{.FullName | anchor}}"></a>
|
|
|
|
### {{.Name}}
|
|
{{.Description}}
|
|
|
|
| Method Name | Request Type | Response Type | Description |
|
|
| ----------- | ------------ | ------------- | ------------|
|
|
{{range .Methods -}}
|
|
| {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType | anchor}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType | anchor}}){{if .ResponseStreaming}} stream{{end}} | {{.Description | replace "\n" "<br/>" | nobr}} |
|
|
{{end}}
|
|
{{end}}<!-- end services -->
|
|
|
|
{{end}}
|
|
|
|
## Scalar Value Types
|
|
|
|
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|
|
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
|
|
{{range .Scalars -}}
|
|
| <a name="{{.ProtoType | anchor}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
|
|
{{end}} |