Kunal cc008ce29e fix: fix HTTP API docs linter for missing params (#1687) ...

## 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 -->

2024-02-23 18:30:22 -08:00

..

hubble

fix: fix HTTP API docs linter for missing params (#1687)

2024-02-23 18:30:22 -08:00

replicator

Add instructions to run replicator manually (#1650)

2024-02-23 18:10:10 -08:00