search

standard-crypto / farcaster-js

MIT License
121 stars 25 forks source link

Bring the swagger doc up to current API spec #573

Closed gsgalloway closed 1 year ago

gsgalloway commented 1 year ago

The original API bindings were generated from an OpenAPI 2.0 spec provided by the Warpcast API team, but was deprecated in favor of written API documentation and has not been kept up-to-date by neither myself nor the Warpcast team.

This of course makes adding new API bindings a nuisance, as the OpenAPI generators cannot be used to create new bindings, and a rather hacky alternative has been used instead -- which is to copy existing generated code and make manual edits to produce bindings for the new endpoints.

The obvious next step is to take over ownership of the OpenAPI spec, bring it up to date, and ensure that the OpenAPI-generated code is readable and accurate.

In addition to making maintenance of this package easier, this can help others interacting with the Warpcast API in different languages.

gsgalloway commented 1 year ago

Warpcast API deprecated; new openapi specs exist for the Hub REST API and Neynar APIs