Skip to content

docs(openapi): fix Miscellanous tag typo + declare Maps and Protocols tag#181

Open
trevormil wants to merge 1 commit intomainfrom
docs-watch/2026-04-24-tag-fixes
Open

docs(openapi): fix Miscellanous tag typo + declare Maps and Protocols tag#181
trevormil wants to merge 1 commit intomainfrom
docs-watch/2026-04-24-tag-fixes

Conversation

@trevormil
Copy link
Copy Markdown
Collaborator

Summary

  • Fix Miscellanous typo (missing "e") on getStatus operation. The alias in scripts/generate-api-routes.ts was quietly papering over it; fix at the source.
  • Declare the Maps and Protocols tag properly — it was referenced by 4 /maps and /mapValues operations but never declared in the top-level tags: block, leaving them grouped under an undocumented tag.
  • Add a short description to the already-declared-but-bare Miscellaneous tag.

No operation bodies change. No visibility change.

Detected by docs-watch agent, 2026-04-24.

Test plan

  • CI: genapi.yml regenerates the hosted spec cleanly
  • Stoplight shows Maps and Protocols as its own group in the navigation with the 4 map operations underneath
  • Miscellaneous group still shows getStatus

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

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-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 24, 2026

Greptile Summary

This PR makes three small corrections to routes.yaml: fixes the Miscellanous typo to Miscellaneous on the getStatus operation, adds a description to the bare Miscellaneous tag, and declares the Maps and Protocols tag that was referenced by 4 map/mapValues operations but never listed in the top-level tags: block. All changes are purely additive doc fixes with no impact on operation bodies or visibility.

Confidence Score: 5/5

Safe 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.

scripts/generate-api-routes.ts has a now-dead typo alias that could be removed in a follow-up.

Important Files Changed

Filename Overview
packages/bitbadgesjs-sdk/openapitypes-helpers/routes.yaml Typo fix (MiscellanousMiscellaneous) 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
Loading

Comments Outside Diff (1)

  1. packages/bitbadgesjs-sdk/scripts/generate-api-routes.ts, line 38 (link)

    P2 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.

    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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant