Endpoint conflict between instance, registry and baremetal

FGRibreau / scaleway-api-client

☁ Scaleway NodeJS API Client 🚀

https://join.slack.com/t/fgribreau/shared_invite/zt-edpjwt2t-Zh39mDUMNQ0QOr9qOj~jrg

5 stars 3 forks source link

Endpoint conflict between instance, registry and baremetal #4

Open korridor opened 3 years ago

korridor commented 3 years ago

Endpoints like ListServers or ListImages are in multiple namespaces and there functions are overwriting each other.

FGRibreau commented 3 years ago

Happy to accept a PR for it! :+1:

mcoolive commented 2 years ago

Hi,

I can work on a PR. But I have a question on the design. Should we simply rename some functions ? Or should we rework the actual SCW-Client and cut it into several APIs ? The first option is simpler to implement. The second option is a big breaking change.

More detail about how I think to divide the actual client:

a smaller client that just hold the common axis config (see ticket #1)
API objects that wrap the client and provide functions limited to: instances, baremetal, etc.
this would presents a naming similar to what is achieved by Scaleway-sdk-go

FGRibreau commented 2 years ago

Hello @mcoolive :) I would go with option two, we will release another major version but it will be way simpler for users, I should have made it that way on the first iteration, sorry ^^'

mcoolive commented 2 years ago

So, should I wait? Or are you interesting by a PR ?

FGRibreau commented 2 years ago

Interested by a PR yes for reworking the client into multiple sub-clients (one for each functions (instances, baremetal, ...)).