Skip to content

Improve Swagger spec for hardware wallet daemon REST API #19

@isaacvr

Description

@isaacvr

Forwarding some thoughts by @Senyoret1 .

  • The generated code in simelo/libjs-skycoin#18 is really big, specially when compared with the code already used in the desktop wallet for consuming the api, which generates problems when creating and reviewing updates.

  • The generated code treats the csrf code as an api key that the code already knows, but in reality it is a value that must be recovered before performing the transaction, asynchronously.

  • The code for validating the params is somewhat chaotic, because sometimes the obligatory params are validated and sometimes not. An interesting example is that in the function for changing the hw configuration the code defines the label as an mandatory param, but in fact it should not be sent when trying not to change the label, but just another configuration param.

  • In the future, the web wallet will be able to connect with various node versions, as well as there could be several versions of the hw daemon. In this case, the automatically generated code would not work, unless several copies are included, one for each compatible version, which is problematic.

  • Some POST API endpoints receive the data in json format and others in form format.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions