Skip to content

Commit

Permalink
docs: add OpenAPI spec for hub-web (#1537)
Browse files Browse the repository at this point in the history
* docs: add OpenAPI spec for hub-web

* update documentation link
  • Loading branch information
gsgalloway authored Jan 20, 2024
1 parent 2c212a2 commit f385961
Show file tree
Hide file tree
Showing 3 changed files with 1,852 additions and 3 deletions.
6 changes: 6 additions & 0 deletions packages/hub-nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ client.$.waitForReady(Date.now() + 5000, async (e) => {
});
```

## Documentation

The HTTP API endpoints are [documented here](https://docs.farcaster.xyz/reference/hubble/httpapi/httpapi).

An OpenAPI spec is provided [here](./spec.yaml).

## Contributing

Please see our [contributing guidelines](https://github.com/farcasterxyz/hubble/blob/main/CONTRIBUTING.md) before making a pull request.
Expand Down
Loading

0 comments on commit f385961

Please sign in to comment.