Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 1 | {{range .Files}} |
Thomas Girardier | 413cc97 | 2022-04-25 11:04:57 -0700 | [diff] [blame] | 2 | # {{.Name | base | replace ".proto" "" | upper}} API |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 3 | |
| 4 | ## Index |
| 5 | |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 6 | {{range .Services -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 7 | * <code><a href=#{{.FullName}}>{{.Name}}</a></code> (interface) |
| 8 | {{end}} |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 9 | {{range .Messages -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 10 | * <code><a href=#{{.FullName}}>{{.Name}}</a></code> (message) |
| 11 | {{end}} |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 12 | {{range .Enums -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 13 | * <code><a href=#{{.FullName}}>{{.Name}}</a></code> (enum) |
| 14 | {{end}} |
| 15 | |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 16 | {{range .Services -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 17 | <a name="{{.FullName}}"></a> |
| 18 | ## {{.Name}} |
| 19 | |
| 20 | {{.Description}} |
| 21 | |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 22 | {{range .Methods -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 23 | ### {{.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 Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 32 | {{range .Messages -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 33 | <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 Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 44 | {{range .Fields -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 45 | <tr> |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 46 | <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 Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 53 | </tr> |
| 54 | {{end}} |
| 55 | </tbody> |
| 56 | </table> |
| 57 | {{end}} |
| 58 | |
| 59 | {{end}} <!-- end Messages--> |
| 60 | |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 61 | {{range .Enums -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 62 | <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 Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 70 | {{range .Values -}} |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 71 | <tr> |
| 72 | <td><code>{{.Name}}</code></td> |
Thomas Girardier | 3e42cdf | 2021-11-03 17:31:57 +0100 | [diff] [blame] | 73 | <td> |
| 74 | <code>{{.Number}}</code> |
| 75 | <br><br> |
| 76 | {{.Description}} |
| 77 | </td> |
Thomas Girardier | bd7b9e8 | 2021-10-29 16:29:21 +0200 | [diff] [blame] | 78 | </tr> |
| 79 | {{end}} |
| 80 | </tbody> |
| 81 | </table> |
| 82 | |
| 83 | {{end}} <!-- end Enums --> |
| 84 | |
| 85 | {{end}} <!-- end Files --> |