Skip to content

generate operation id #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VojtechVitek merged 2 commits into from
May 6, 2025
Merged

generate operation id #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c8857e
generate operation id
LukasJenicek May 5, 2025
430d2ed
use dash as separator between service and method name
LukasJenicek May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions _examples/openapi.gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,7 @@ components:
paths:
/rpc/ExampleService/Ping:
post:
operationId: ExampleService-Ping
tags: ["ExampleService"]
summary: "Deprecated."
deprecated: true
Expand Down Expand Up @@ -542,6 +543,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/GetUser:
post:
operationId: ExampleService-GetUser
tags: ["ExampleService"]
summary: "Deprecated: Use GetUserV2 instead."
deprecated: true
Expand Down Expand Up @@ -585,6 +587,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/GetUserV2:
post:
operationId: ExampleService-GetUserV2
tags: ["ExampleService"]
summary: "GetUserV2 returns user based on given userID."
security:
Expand Down Expand Up @@ -629,6 +632,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/FindUser:
post:
operationId: ExampleService-FindUser
tags: ["ExampleService"]
summary: "FindUser searches for a user using the given search filter."
security:
Expand Down Expand Up @@ -676,6 +680,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/ListUsers:
post:
operationId: ExampleService-ListUsers
tags: ["ExampleService"]
summary: "ListUsers returns all users."
security:
Expand Down Expand Up @@ -718,6 +723,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/GetComplex:
post:
operationId: ExampleService-GetComplex
tags: ["ExampleService"]
summary: ""
requestBody:
Expand Down Expand Up @@ -758,6 +764,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/ExampleService/GetAllOptional:
post:
operationId: ExampleService-GetAllOptional
tags: ["ExampleService"]
summary: ""
requestBody:
Expand Down Expand Up @@ -798,6 +805,7 @@ paths:
- $ref: '#/components/schemas/ErrorDatabaseDown'
/rpc/AdminService/ListUsers:
post:
operationId: AdminService-ListUsers
tags: ["AdminService"]
summary: ""
security:
Expand Down
1 change: 1 addition & 0 deletions main.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ paths:
{{- $deprecated := index $method.Annotations "deprecated" }}
/rpc/{{$service.Name}}/{{$method.Name}}:
post:
operationId: {{$service.Name}}-{{$method.Name}}
tags: ["{{$service.Name}}"]
summary: {{ if $deprecated }}{{ if $deprecated.Value }}{{printf "%q" (print "Deprecated: " $deprecated.Value)}}{{else}}"Deprecated."{{end}}{{else if gt (len $method.Comments) 0}}{{printf "%q" (index $method.Comments 0)}}{{else}}""{{end}}
{{- if $deprecated }}
Expand Down