Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-30 20:33:54 -05:00
Code Issues Activity
logto/.changeset/brown-cobras-know.md
Mostafa Moradian d60f6ce48e
feat: add operationId to HTTP methods on paths (#6108) 
* feat: add operationId to HTTP methods on paths

* refactor(core): strictly handle routes for building operation id

* chore: add changeset

* refactor: reorg code

* refactor: use get as verb for singular items

---------

Co-authored-by: Gao Sun <gao@silverhand.io>
2024-07-03 05:19:59 +00:00

950 B
Raw Blame History

@logto/core
patch

build operationId for Management API in OpenAPI response (credit to @mostafa)

As per the specification:

operationId is an optional unique string used to identify an operation. If provided, these IDs must be unique among all operations described in your API.

This greatly simplifies the creation of client SDKs in different languages, because it generates more meaningful function names instead of auto-generated ones, like the following examples:

- org, _, err := s.Client.OrganizationsAPI.ApiOrganizationsIdGet(ctx, req.GetId()).Execute()
+ org, _, err := s.Client.OrganizationsAPI.GetOrganization(ctx, req.GetId()).Execute()

- users, _, err := s.Client.OrganizationsAPI.ApiOrganizationsIdUsersGet(ctx, req.GetId()).Execute()
+ users, _, err := s.Client.OrganizationsAPI.ListOrganizationUsers(ctx, req.GetId()).Execute()