Merge pull request #18 from webrpc/description

use method name as summary and comments as description
webrpc · Mar 18, 2024 · 52e43d8 · 52e43d8
2 parents 7698afa + 1e89295
commit 52e43d8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/_examples/openapi.gen.yaml b/_examples/openapi.gen.yaml
@@ -477,6 +477,7 @@ components:
 paths:
   /rpc/ExampleService/GetUser:
     post:
+      summary: GetUser
       requestBody:
         content:
           application/json:
@@ -515,6 +516,7 @@ paths:
                 - $ref: '#/components/schemas/ErrorDatabaseDown'
   /rpc/ExampleService/FindUser:
     post:
+      summary: FindUser
       requestBody:
         content:
           application/json:
@@ -553,6 +555,7 @@ paths:
                 - $ref: '#/components/schemas/ErrorDatabaseDown'
   /rpc/ExampleService/ListUsers:
     post:
+      summary: ListUsers
       requestBody:
         content:
           application/json:
@@ -591,6 +594,7 @@ paths:
                 - $ref: '#/components/schemas/ErrorDatabaseDown'
   /rpc/ExampleService/GetComplex:
     post:
+      summary: GetComplex
       requestBody:
         content:
           application/json:
@@ -629,6 +633,7 @@ paths:
                 - $ref: '#/components/schemas/ErrorDatabaseDown'
   /rpc/ExampleService/GetAllOptional:
     post:
+      summary: GetAllOptional
       requestBody:
         content:
           application/json:
@@ -667,6 +672,7 @@ paths:
                 - $ref: '#/components/schemas/ErrorDatabaseDown'
   /rpc/ClonedService/ListUsers:
     post:
+      summary: ListUsers
       requestBody:
         content:
           application/json:
@@ -702,4 +708,4 @@ paths:
                 - $ref: '#/components/schemas/ErrorWebrpcBadResponse'
                 - $ref: '#/components/schemas/ErrorWebrpcServerPanic'
                 - $ref: '#/components/schemas/ErrorWebrpcInternalError'
-                - $ref: '#/components/schemas/ErrorDatabaseDown'
+                - $ref: '#/components/schemas/ErrorDatabaseDown'
diff --git a/main.go.tmpl b/main.go.tmpl
@@ -128,8 +128,9 @@ paths:
   {{- range $_, $method := .Methods}}
   /rpc/{{$service.Name}}/{{$method.Name}}:
     post:
+      summary: {{$method.Name}}
     {{- if gt (len $method.Comments) 0 }}
-      summary: "{{ replaceAll (join $method.Comments "\n") "\"" "'" }}"
+      description: "{{ replaceAll (join $method.Comments "\n") "\"" "'" }}"
     {{- end }}
       requestBody:
         content: