itchio / go-itchio Goto Github PK

Hello! I'm building an itch.io app for Ubuntu Touch and I'm using this repository as a kind-of API documentation. Is there a way to pass additional parameters to the search endpoint?

Having the ability to filter by platform and tags would be what I'm looking for.

Right now, it should be requesting API v2.

See #2

This is not an immediate issue as https://api.itch.io/ serves version 2 - but we don't want folks releasing software using a version of go-itchio that doesn't have that header.

At this point in time, only internal projects (which we can upgrade easily) and https://github.com/itchio/itch-setup (which isn't released yet) use go-itchio's v2. butler is still using an older go-itchio version that talks to API v1.

If a server was to actually return the types that go-itchio says it expects, and then butler or another service using go-itchio tried to use those types, time parsing would fail (causing e.g. butler to crash) because APIDateFormat isn't RFC3999, which is what time.Time will be encoded as in json.

This means that servers trying to respond to butlers requests right now would have to duplicate the contents of the types.go file and change the time.Time values into something that can have the right format, or otherwise wrap all types so that they could write their own MarshalJSON function.

If every type (with timestamps) in the package had a MarshalJSON function which formatted their times using APIDateFormat, this would be resolved without breaking the API, and a breaking API change for DYI could be to move out the CreatedAt/UpdatedAt pairs into a type that would be embedded in the types that use it, and just MarshalJSON that and the CreatedAt/PublishedAt field for a game.

An alternative solution would be somehow working with the mapstructure package to support RFC 3999, as this line is currently the one enforcing that json received uses APIDateFormat.