docs(openapi): fix Miscellanous tag typo + declare Maps and Protocols tag#181
docs(openapi): fix Miscellanous tag typo + declare Maps and Protocols tag#181
Conversation
Two tag-hygiene fixes in `routes.yaml`: 1. `getStatus` was tagged `Miscellanous` (missing "e"), which was being rescued by an alias in `scripts/generate-api-routes.ts`. Fix the source. The alias can stay as a safety net for now. 2. Four `/maps` and `/mapValues` operations reference a `Maps and Protocols` tag that was never declared in the top-level `tags:` list — so Stoplight was grouping them under an undocumented tag with no description. Declare it properly, alongside a description for the already-declared-but-undocumented `Miscellaneous` tag. No operation bodies change. No visibility change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Greptile SummaryThis PR makes three small corrections to Confidence Score: 5/5Safe to merge — only OpenAPI tag metadata changes, no operation logic altered. All three changes are straightforward doc corrections; the only remaining finding is a P2 dead-alias cleanup in a file not touched by this PR.
|
| Filename | Overview |
|---|---|
| packages/bitbadgesjs-sdk/openapitypes-helpers/routes.yaml | Typo fix (Miscellanous → Miscellaneous) on getStatus, added description to Miscellaneous tag, and declared the previously undocumented Maps and Protocols tag — all changes are correct. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[routes.yaml top-level tags] --> B[Miscellaneous - description added]
A --> C[Maps and Protocols - newly declared]
D[getStatus operation] -->|was Miscellanous| E[undeclared tag - broken]
D -->|now Miscellaneous| B
F[maps operations x4] --> C
Comments Outside Diff (1)
-
packages/bitbadgesjs-sdk/scripts/generate-api-routes.ts, line 38 (link)Dead alias not removed after typo fix
The
generate-api-routes.tsalias'Miscellanous': 'misc'(line 38) was added specifically to paper over the typo inroutes.yaml. Now that the spec is fixed, this entry is unreachable dead code — no operation tag in the YAML will ever equal'Miscellanous'again. The PR description explicitly acknowledges it exists but leaves it in place. Consider removing it in a follow-up (or this PR) to avoid confusion for future readers.Prompt To Fix With AI
This is a comment left during a code review. Path: packages/bitbadgesjs-sdk/scripts/generate-api-routes.ts Line: 38 Comment: **Dead alias not removed after typo fix** The `generate-api-routes.ts` alias `'Miscellanous': 'misc'` (line 38) was added specifically to paper over the typo in `routes.yaml`. Now that the spec is fixed, this entry is unreachable dead code — no operation tag in the YAML will ever equal `'Miscellanous'` again. The PR description explicitly acknowledges it exists but leaves it in place. Consider removing it in a follow-up (or this PR) to avoid confusion for future readers. How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: packages/bitbadgesjs-sdk/scripts/generate-api-routes.ts
Line: 38
Comment:
**Dead alias not removed after typo fix**
The `generate-api-routes.ts` alias `'Miscellanous': 'misc'` (line 38) was added specifically to paper over the typo in `routes.yaml`. Now that the spec is fixed, this entry is unreachable dead code — no operation tag in the YAML will ever equal `'Miscellanous'` again. The PR description explicitly acknowledges it exists but leaves it in place. Consider removing it in a follow-up (or this PR) to avoid confusion for future readers.
```suggestion
'Miscellaneous': 'misc',
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "docs(openapi): fix tag typo + declare mi..." | Re-trigger Greptile
Summary
Miscellanoustypo (missing "e") ongetStatusoperation. The alias inscripts/generate-api-routes.tswas quietly papering over it; fix at the source.Maps and Protocolstag properly — it was referenced by 4/mapsand/mapValuesoperations but never declared in the top-leveltags:block, leaving them grouped under an undocumented tag.Miscellaneoustag.No operation bodies change. No visibility change.
Detected by docs-watch agent, 2026-04-24.
Test plan
genapi.ymlregenerates the hosted spec cleanlyMaps and Protocolsas its own group in the navigation with the 4 map operations underneathMiscellaneousgroup still showsgetStatusCo-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com