blob: e691639750e02b703737a0ea89bcd8961f08c350 [file] [log] [blame]
Thomas Girardierbd7b9e82021-10-29 16:29:21 +02001{{range .Files}}
Thomas Girardier413cc972022-04-25 11:04:57 -07002# {{.Name | base | replace ".proto" "" | upper}} API
Thomas Girardierbd7b9e82021-10-29 16:29:21 +02003
4## Index
5
Thomas Girardier3e42cdf2021-11-03 17:31:57 +01006{{range .Services -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +02007* <code><a href=#{{.FullName}}>{{.Name}}</a></code> (interface)
8{{end}}
Thomas Girardier3e42cdf2021-11-03 17:31:57 +01009{{range .Messages -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020010* <code><a href=#{{.FullName}}>{{.Name}}</a></code> (message)
11{{end}}
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010012{{range .Enums -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020013* <code><a href=#{{.FullName}}>{{.Name}}</a></code> (enum)
14{{end}}
15
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010016{{range .Services -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020017<a name="{{.FullName}}"></a>
18## {{.Name}}
19
20{{.Description}}
21
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010022{{range .Methods -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020023### {{.Name}}
24<code> rpc {{.Name}}({{if .RequestStreaming}}stream {{end}}<a href=#{{.RequestFullType}}>{{.RequestLongType}}</a>) returns ({{if .ResponseStreaming}}stream {{end}}<a href=#{{.ResponseFullType}}>{{.ResponseLongType}}</a>)</code>
25
26{{.Description}}
27
28{{end}} <!-- end Methods -->
29
30{{end}} <!-- end Services -->
31
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010032{{range .Messages -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020033<a name="{{.FullName}}"></a>
34## {{.Name}}
35
36{{.Description}}
37
38{{if .HasFields}}
39<table class="properties responsive">
40 <thead>
41 <tr><th colspan="2">Fields</th></tr>
42 </thead>
43 <tbody>
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010044 {{range .Fields -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020045 <tr>
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010046 <td><code>{{if .IsOneof}}<a href=https://developers.google.com/protocol-buffers/docs/proto3#oneof>oneof</a> {{.OneofDecl}}.{{end}}{{.Name}}</code></td>
47 <td>
48 <code><a href=#{{.FullType}}>{{.LongType}}</a></code>
49 <br><br>
50 {{.Description}}
51 {{if .DefaultValue}}<br><br>Default: <code>{{.DefaultValue}}</code>{{end}}
52 </td>
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020053 </tr>
54 {{end}}
55 </tbody>
56</table>
57{{end}}
58
59{{end}} <!-- end Messages-->
60
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010061{{range .Enums -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020062<a name="{{.FullName}}"></a>
63## {{.LongName}}
64
65<table class="constants responsive">
66 <thead>
67 <tr><th colspan="2">Enums</th></tr>
68 </thead>
69 <tbody>
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010070 {{range .Values -}}
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020071 <tr>
72 <td><code>{{.Name}}</code></td>
Thomas Girardier3e42cdf2021-11-03 17:31:57 +010073 <td>
74 <code>{{.Number}}</code>
75 <br><br>
76 {{.Description}}
77 </td>
Thomas Girardierbd7b9e82021-10-29 16:29:21 +020078 </tr>
79 {{end}}
80 </tbody>
81</table>
82
83{{end}} <!-- end Enums -->
84
85{{end}} <!-- end Files -->