Skip to content

Commit 63ec3bf

Browse files
authoredApr 24, 2024
render comments in webrpc methods (#67)
1 parent badb0e7 commit 63ec3bf

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed
 

‎_examples/golang-basics/example.gen.go

+9-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎_examples/golang-basics/example.ridl

+3
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ error 400300 UserNotFound "user not found"
8989

9090
service ExampleService
9191
- Ping()
92+
# Status endpoint
93+
#
94+
# gives you current status of running application
9295
- Status() => (status: bool)
9396
- Version() => (version: Version)
9497
- GetUser(header: map<string,string>, userID: uint64) => (user: User)

‎_examples/golang-imports/api.gen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎types.go.tmpl

+10
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ var WebRPCServices = map[string][]string{
4747
{{ if $opts.types -}}
4848
type {{$service.Name}} interface {
4949
{{- range $_, $method := $service.Methods}}
50+
{{- if gt (len $method.Comments) 0 -}}
51+
{{- range $_, $comment := $method.Comments }}
52+
// {{ replaceAll $comment "\"" "'" }}
53+
{{- end }}
54+
{{- end }}
5055
{{ if eq $method.StreamOutput true -}}
5156
{{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}, stream {{$method.Name}}StreamWriter) error
5257
{{- else -}}
@@ -144,6 +149,11 @@ func (w *streamWriter) write(respPayload interface{}) error {
144149
{{ range $_, $service := $services -}}
145150
type {{$service.Name}}Client interface {
146151
{{- range $_, $method := $service.Methods}}
152+
{{- if gt (len $method.Comments) 0 }}
153+
{{- range $_, $comment := $method.Comments }}
154+
// {{ replaceAll $comment "\"" "'" }}
155+
{{- end }}
156+
{{- end }}
147157
{{ if eq $method.StreamOutput true -}}
148158
{{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}) ({{$method.Name}}StreamReader, error)
149159
{{- else -}}

0 commit comments

Comments
 (0)