Skip to content

docs(openapi): fix Miscellanous typo, declare Maps and Protocols tag#169

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

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

Conversation

@trevormil
Copy link
Copy Markdown
Collaborator

Summary

Two small tag-consistency issues that surface in the Stoplight-rendered public reference:

  1. Typo'd tag on /status — it's tagged Miscellanous (missing the e), while the top-level tags: list declares Miscellaneous. Stoplight treats these as distinct groups, so /status ends up under a typo'd section instead of the intended Miscellaneous bucket.

  2. Undeclared Maps and Protocols tag — four routes (/maps, /maps/{mapId}, /mapValues, /mapValue/{mapId}/{key}) are grouped under Maps and Protocols but the tag is never declared at the top level, so Stoplight renders them as an untitled/undescribed group.

Fix:

  • Change Miscellanous -> Miscellaneous on /status
  • Add Maps and Protocols to the top-level tags: list with a one-line description

Test plan

  • After merge, verify on Stoplight that /status renders under Miscellaneous and the Maps and Protocols group has its description.

Generated by the docs-watch agent (daily OpenAPI quality sweep).

Two tag consistency issues in the hosted OpenAPI spec:

1. /status used the tag "Miscellanous" (missing the 'e'), while the
   top-level tags list declares "Miscellaneous". Stoplight treats these
   as distinct groups, so /status showed up under a typo'd section
   instead of the intended Miscellaneous bucket.

2. Four /maps endpoints (/maps, /maps/{mapId}, /mapValues,
   /mapValue/{mapId}/{key}) are tagged "Maps and Protocols" but that tag
   was never declared at the top level, which causes Stoplight to render
   them as an untitled group with no description.

Fix the typo and add the missing tag declaration with a brief
description matching the other tag entries.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 22, 2026

Greptile Summary

This PR makes two small, targeted OpenAPI documentation fixes in routes.yaml to resolve tag consistency issues in the Stoplight-rendered public reference:

  • Typo fix: The /status endpoint was tagged Miscellanous (missing e), causing Stoplight to render it under a separate, typo'd group. Corrected to Miscellaneous.
  • Undeclared tag: Four map-related routes (/maps, /maps/{mapId}, /mapValues, /mapValue/{mapId}/{key}) referenced a Maps and Protocols tag that had no top-level declaration. The tag is now declared with a one-line description.

No code logic, types, or runtime behaviour are changed — purely YAML metadata.

Confidence Score: 5/5

Safe to merge — purely documentation metadata corrections with no runtime or logic impact.

Both changes are straightforward, verifiable fixes to YAML tag declarations. The typo correction and the new top-level tag declaration are exactly what they claim to be, and the four Maps and Protocols routes already in the file confirm the tag was genuinely missing.

No files require special attention.

Important Files Changed

Filename Overview
packages/bitbadgesjs-sdk/openapitypes-helpers/routes.yaml Fixes typo MiscellanousMiscellaneous on the /status tag and declares the Maps and Protocols tag at the top-level with a description; no logic changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["/status endpoint"] -->|was tagged| B["Miscellanous (typo'd)"]
    A -->|now tagged| C["Miscellaneous ✓"]

    D["Maps routes\n/maps, /maps/{mapId}\n/mapValues, /mapValue/{mapId}/{key}"] -->|referenced undeclared tag| E["Maps and Protocols (no top-level entry)"]
    E -->|now declared in tags list| F["Maps and Protocols\ndescription: Endpoints for on-chain maps\nand registered protocol definitions ✓"]
Loading

Reviews (1): Last reviewed commit: "docs(openapi): fix Miscellanous typo, de..." | 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