2021-04-01 17:34:44 -07:00
|
|
|
---
|
2022-11-02 11:46:54 -07:00
|
|
|
id: protobuf-api
|
2021-04-01 17:34:44 -07:00
|
|
|
title: Protobuf API Reference
|
2022-11-03 19:24:31 -07:00
|
|
|
slug: /developers/protobufs/api
|
2022-11-03 17:10:08 -07:00
|
|
|
sidebar_label: Protobufs
|
2022-11-02 14:50:50 -07:00
|
|
|
sidebar_position: 20
|
2021-04-01 17:34:44 -07:00
|
|
|
---
|
|
|
|
|
|
2022-11-02 11:46:54 -07:00
|
|
|
<!-- THIS PAGE IS AUTOGENERATED FROM ./scripts/gen-proto-docs.sh DO NOT EDIT -->
|
|
|
|
|
|
2021-04-01 17:34:44 -07:00
|
|
|
{{range .Files}}
|
|
|
|
|
## {{.Name}}
|
|
|
|
|
{{if .Messages}}
|
|
|
|
|
{{range .Messages}}
|
|
|
|
|
|
|
|
|
|
### {{.LongName}}
|
|
|
|
|
{{if .Description}}
|
|
|
|
|
:::note `message` description
|
|
|
|
|
{{.Description}}
|
|
|
|
|
:::
|
|
|
|
|
{{end}}
|
|
|
|
|
|
|
|
|
|
{{if .HasFields}}
|
|
|
|
|
| Field | Type | Description |
|
|
|
|
|
| ----- | ---- | ----------- |
|
|
|
|
|
{{range .Fields -}}
|
|
|
|
|
| {{if .IsOneof}}[**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) {{.OneofDecl}}.{{end}}{{.Name}} | {{if eq (index .LongType 0) (index (.LongType | upper) 0 )}}[`{{.LongType}}`](#{{.LongType | lower | replace "." ""}}){{else}}{{.LongType}}{{end}} | {{if .Description}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}{{else}}none{{end}} |
|
|
|
|
|
{{end}}
|
|
|
|
|
{{end}}
|
|
|
|
|
{{end}}
|
|
|
|
|
|
|
|
|
|
{{end}}
|
|
|
|
|
{{if .Enums}}
|
|
|
|
|
{{range .Enums}}
|
|
|
|
|
|
|
|
|
|
### {{.LongName}}
|
|
|
|
|
{{if .Description}}
|
|
|
|
|
:::note `enum` description
|
|
|
|
|
{{.Description}}
|
|
|
|
|
:::
|
|
|
|
|
{{end}}
|
|
|
|
|
|
|
|
|
|
| Name | Number | Description |
|
|
|
|
|
| ---- | ------ | ----------- |
|
|
|
|
|
{{range .Values -}}
|
|
|
|
|
| `{{.Name}}` | `{{.Number}}` | {{if .Description}}{{nobr .Description}}{{else}}none{{end}} |
|
|
|
|
|
{{end}}
|
|
|
|
|
|
|
|
|
|
{{end}}
|
|
|
|
|
{{end}}
|
|
|
|
|
{{end}}
|
