mirror of https://github.com/poanetwork/quorum.git
76 lines
2.1 KiB
Cheetah
76 lines
2.1 KiB
Cheetah
<!-- This is auto generated file from running `go generate` in plugin/proto folder. Please do not edit -->
|
|
|
|
{{range .Files}}
|
|
{{$file_name := .Name}}
|
|
<a name="{{.Name}}"></a>
|
|
|
|
## {{.Name}}
|
|
{{.Description}}
|
|
|
|
### Services
|
|
|
|
{{range .Services}}
|
|
<a name="{{.FullName}}"></a>
|
|
|
|
#### `{{.Name}}`
|
|
{{.Description}}
|
|
|
|
| Method Name | Request Type | Response Type | Description |
|
|
| ----------- | ------------ | ------------- | ------------|
|
|
{{range .Methods -}}
|
|
| {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
|
|
{{end}}
|
|
{{end}} <!-- end services -->
|
|
|
|
### Messsages
|
|
|
|
{{range .Messages}}
|
|
<a name="{{.FullName}}"></a>
|
|
|
|
#### `{{.LongName}}`
|
|
{{.Description}}
|
|
|
|
{{if .HasFields}}
|
|
| Field | Type | Label | Description |
|
|
| ----- | ---- | ----- | ----------- |
|
|
{{range .Fields -}}
|
|
| {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{if .HasExtensions}}
|
|
| Extension | Type | Base | Number | Description |
|
|
| --------- | ---- | ---- | ------ | ----------- |
|
|
{{range .Extensions -}}
|
|
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{end}} <!-- end messages -->
|
|
|
|
{{range .Enums}}
|
|
<a name="{{.FullName}}"></a>
|
|
|
|
#### `{{.LongName}}`
|
|
{{.Description}}
|
|
|
|
| Name | Number | Description |
|
|
| ---- | ------ | ----------- |
|
|
{{range .Values -}}
|
|
| {{.Name}} | {{.Number}} | {{nobr .Description}} |
|
|
{{end}}
|
|
|
|
{{end}} <!-- end enums -->
|
|
|
|
{{if .HasExtensions}}
|
|
<a name="{{$file_name}}-extensions"></a>
|
|
|
|
#### File-level Extensions
|
|
| Extension | Type | Base | Number | Description |
|
|
| --------- | ---- | ---- | ------ | ----------- |
|
|
{{range .Extensions -}}
|
|
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
|
|
{{end}}
|
|
{{end}} <!-- end HasExtensions -->
|
|
|
|
{{end}} |