Use auth annotations to render security schema in method section

webrpc · Oct 7, 2024 · ae2b44e · ae2b44e
1 parent c809810
commit ae2b44e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/_examples/openapi.gen.yaml b/_examples/openapi.gen.yaml
@@ -1,4 +1,4 @@
-# example v0.0.1 ebe5209e9238f02a045c540943d0298b747f5f03
+# example v0.0.1 9e3db8dcce83f00fbc6c12b6a2b712b5fdd38874
 # --
 # Code generated by [email protected] with ../ generator; DO NOT EDIT
 # 
@@ -537,6 +537,9 @@ paths:
  /rpc/ExampleService/GetUserV2:
  post:
  summary: GetUserV2
+ security:
+ - ApiKeyAuth: []
+ - ServiceAuth: []
  requestBody:
  content:
  application/json:

diff --git a/_examples/proto.ridl b/_examples/proto.ridl
@@ -47,6 +47,7 @@ struct Optional
 service ExampleService
  @deprecated:GetUserV2
  - GetUser(header: map<string,string>, userID: uint64) => (code: uint32, user: User)
+ @auth:"ApiKeyAuth,ServiceAuth"
  - GetUserV2(header: map<string,string>, userID: uint64) => (code: uint32, user: User, profilePicture: string)
  - FindUser(s: SearchFilter) => (name: string, user: User)
  - ListUsers() => (users: []User)

diff --git a/main.go.tmpl b/main.go.tmpl
@@ -132,6 +132,14 @@ paths:
  {{- if (index $method.Annotations "deprecated") }}
  deprecated: true
  {{- end }}
+ {{- if (index $method.Annotations "auth") }}
+ security:
+ {{- $auth := index $method.Annotations "auth" -}}
+ {{- $authParts := split "," $auth.Value -}}
+ {{- range $authParts }}
+ - {{ . }}: []
+ {{- end }}
+ {{- end }}
  {{- if gt (len $method.Comments) 0 }}
  description: "{{ replaceAll (join $method.Comments "\n") "\"" "'" }}"
  {{- end }}