mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-04-18 03:00:22 -04:00
cc008ce29e
## Motivation The HTTP API Doc Linter throws a confusing error when the list of parameters in an endpoint is missing. Instead, if a new HTTP doc doesn't specify a list of parameters, assume it's empty. Example failing lint: https://github.com/farcasterxyz/hub-monorepo/actions/runs/7819553394/job/21332224262?pr=1630 The error was: ``` @farcaster/hubble:lint:ci: Parameter "event_id" is documented in the parameters table (on events.md:10) for endpoint "currentPeers" but is not specified in the @doc-tag (on httpServer.ts: line 242) ``` The lint error references `events.md` (not relevant to the changeset in the PR), which was confusing. This was because `foundEndpoint` carried over between files. ## Change Summary Small fix to `getParametersForEndpoint` to scope parameters to a file ## Merge Checklist _Choose all relevant options below by adding an `x` now or at any time before submitting for review_ - [x] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [ ] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [ ] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [ ] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. - [ ] All [commits have been signed](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#22-signing-commits) ## Additional Context <!-- start pr-codex --> --- ## PR-Codex overview ### Focus of the PR: Refactoring the `getParametersForEndpoint` function in `httpapidocs.js` to improve readability and simplify the code structure. ### Detailed summary: - Replaced nested `forEach` loops with `for...of` loops for better code readability. - Removed unnecessary variable initialization and reset. - Changed variable declaration for `parameters` to `const` for better code clarity. - Added comments to explain the purpose of the function. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
Hubble Monorepo
This monorepo contains Hubble, an official Farcaster Hub implementation, and other packages used to communicate with Hubble.
Getting Started
- To run Hubble, see the Hubble docs.
- To use Hubble, see the hub-nodejs docs.
- To use the HTTP API to read Hubble data, see the HTTP API docs
Packages
| Package Name | Description |
|---|---|
| @farcaster/hubble | A Farcaster Hub implementation |
| @farcaster/hub-nodejs | A Node.js client library for Hubble |
| @farcaster/hub-web | A Browser client library for Hubble |
| @farcaster/core | Shared code between all packages |
Contributing
Please see CONTRIBUTING.md