-
-
Notifications
You must be signed in to change notification settings - Fork 347
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: generate gRPC reference page (#488)
- Loading branch information
Showing
30 changed files
with
577 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,11 @@ jobs: | |
| version: '3.12.x' | ||
| - name: Lint and Build | ||
| run: make buf | ||
| - name: Format Docs (required because buf generates the proto docs) | ||
| run: | | ||
| cd docs | ||
| npm ci | ||
| npm run format | ||
| - name: Push build | ||
| run: | | ||
| git config --local user.email "[email protected]" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: Protocol Buffers API | ||
| --- | ||
|
|
||
| <!-- This file is generated. Please edit the .proto files instead to update the documentation --> | ||
|
|
||
| The API is divided into the [read API](/TODO) and [write API](/TODO). | ||
| Each service is annotated with the API it belongs to. | ||
|
|
||
| {{range .Files}} | ||
| {{$file_name := .Name}} | ||
|
|
||
| ## {{.Name}} | ||
| {{.Description}} | ||
|
|
||
| {{range .Services}} | ||
|
|
||
| ### {{.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 | replace "\n\n" "<br/>" }} | | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{range .Messages}} | ||
|
|
||
| ### {{.LongName}} | ||
| {{.Description}} | ||
|
|
||
| {{if .HasFields}} | ||
| | Field | Type | Label | Description | | ||
| | ----- | ---- | ----- | ----------- | | ||
| {{range .Fields -}} | ||
| | {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description | replace "\n\n" "<br/>" }}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{if .HasExtensions}} | ||
| | Extension | Type | Base | Number | Description | | ||
| | --------- | ---- | ---- | ------ | ----------- | | ||
| {{range .Extensions -}} | ||
| | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description | replace "\n\n" "<br/>" }}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{end}} | ||
|
|
||
| {{range .Enums}} | ||
|
|
||
| ### {{.LongName}} | ||
| {{.Description}} | ||
|
|
||
| | Name | Number | Description | | ||
| | ---- | ------ | ----------- | | ||
| {{range .Values -}} | ||
| | {{.Name}} | {{.Number}} | {{nobr .Description | replace "\n\n" "<br/>" }} | | ||
| {{end}} | ||
|
|
||
| {{end}} | ||
|
|
||
| {{if .HasExtensions}} | ||
|
|
||
| ### File-level Extensions | ||
| | Extension | Type | Base | Number | Description | | ||
| | --------- | ---- | ---- | ------ | ----------- | | ||
| {{range .Extensions -}} | ||
| | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description | replace "\n\n" "<br/>" }}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{end}} | ||
|
|
||
| ## Scalar Value Types | ||
|
|
||
| | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | ||
| | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | | ||
| {{range .Scalars -}} | ||
| | <a id="{{.ProtoType}}" ></a> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} | | ||
| {{end}} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.