Skip to content

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

@csadorf

Description

@csadorf

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions