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

Allocation creation requires confusing parameters #3150

Open
grisha87 opened this issue Apr 4, 2024 · 3 comments · May be fixed by golemfactory/ya-client#176
Open

Allocation creation requires confusing parameters #3150

grisha87 opened this issue Apr 4, 2024 · 3 comments · May be fixed by golemfactory/ya-client#176
Assignees
Labels
sdk-request issue requested by SDK team

Comments

@grisha87
Copy link
Contributor

grisha87 commented Apr 4, 2024

With the recently introduced changes to ya-client the allocation creation can take in two types of parameters in the request body:

{
  makeDeposit: boolean | undefiend
  deposit: { contract: string, id: string }
}

As far as the API specs explain, the makeDeposit property is not used. From the end-user perspective this looks like the API would support the following scenario: Given I specified deposit and set makeDeposit then doing the call will create the deposit for me.

I believe that we should deprecate the makeDeposit field and remove it in the near future.

@grisha87 grisha87 added the sdk-request issue requested by SDK team label Apr 4, 2024
@golmek
Copy link
Contributor

golmek commented Apr 5, 2024

I agree that it will be confusing as hell. Should be cleared out with Gisha suggestion.

@kamirr
Copy link
Contributor

kamirr commented Apr 5, 2024

A good first step would be to stop requiring this field in the spec and marking it as deprecated. We can't remove it outright due to backward compat.

@kamirr
Copy link
Contributor

kamirr commented May 24, 2024

reqc will deliver this, detaching from payments UX.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sdk-request issue requested by SDK team
Projects
None yet
3 participants