GwentAPI / gwentapi

The code for GwentAPI
https://gwentapi.com
BSD 3-Clause "New" or "Revised" License
47 stars 1 forks source link

V1 wishlist #37

Open Tri125 opened 6 years ago

Tri125 commented 6 years ago

Use this issue to request changes that you would like to see in the v1 release. This is a major version so don't be afraid to ask for breaking changes.

Tri125 commented 6 years ago

I can't say that #25 will make the cut but #15 will. I'd like to provide general improvement with the search without making any major overhaul for this release.

Goa, the framework that the project has been using, will be removed. It should be easier for contributors to get into the project without this huge framework. I'm aiming to replace it with gRPC + grpc-gateway to continue providing a RESTful interface. I expect a regression in term of the specs of GwentAPI particularly concerning the headers that was added to help client cache responses as gRPC doesn't seems to have the concept of caching just yet. As GwentAPI was meant to be a learning experience, switching to gRPC will continue with that goal.

Tokens will be part of the API.

Multiple image per card might disappear since triple art cards are gone with the Midwinter Update. I will find a way for the API spec to support alternative arts or at the minimum the animated cards in the off chance that CD RED makes it possible to extract them in the future.

The API will provide a data version number to you can quickly see if the data was updated.

I don't like that you need to send 2 requests per card to get the full information.

Kimi-Arthur commented 6 years ago

Is it possible to add Chinese?