Skip to content
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.

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

Mapping of operations via actual endpoint path instead of operationID #41

Open
csadorf opened this issue Aug 24, 2022 · 4 comments
Open
Labels
question Further information is requested

Comments

@csadorf
Copy link
Collaborator

csadorf commented Aug 24, 2022

Currently the proxy service (and thus the SDK) uses the operation id instead of the path documented in the standard app api to make requests to an app.

Example:

self._proxy_path("listCollections"),

I propose to use the actual paths, not the operation ids, because

  1. The operation ids are actually not very visible in the standard API viewers (swagger, redocly).
  2. The paths were designed to follow RESTful principles (represent resources, not actions).
  3. I believe it would be very surprising to app developers that they need to translate the API in such an unorthodox way.

However, I'd be interested to hear the arguments for the choice of using the operation ids. @pablo-de-andres @yoavnash Can you comment on this?

@csadorf csadorf added the question Further information is requested label Aug 24, 2022
@pablo-de-andres
Copy link
Member

So the correspondance would have to be from the operation ids in the specification of the registered app to the paths of the SDK, right? Apps would still indicate the capability in the operation id when they register?

I don't see why not, it should not require much change.
If we want to move forward with this, I would suggest moving it to the GitLab issue board.

@csadorf
Copy link
Collaborator Author

csadorf commented Aug 25, 2022

Just to make sure we are on the same page, as an example, to list all available transformations, with my proposed change one would make the following call to the proxy:

api/applications/proxy/{app_id}/transformations/

instead of

api/applications/proxy/{app_id}/listTransformations

Once you confirm I can create an issue on the GitLab issue board.

@pablo-de-andres
Copy link
Member

Yes, I agree. I just meant that registering app will still use operationIds

@csadorf
Copy link
Collaborator Author

csadorf commented Aug 29, 2022

I've created the corresponding issue on GitLab: https://gitlab.cc-asp.fraunhofer.de/MarketPlace/platform/issue-reporting/-/issues/130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants