docs(openapi): fix Miscellanous typo, declare Maps and Protocols tag#169
Open
docs(openapi): fix Miscellanous typo, declare Maps and Protocols tag#169
Conversation
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 SummaryThis PR makes two small, targeted OpenAPI documentation fixes in
No code logic, types, or runtime behaviour are changed — purely YAML metadata. Confidence Score: 5/5Safe 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.
|
| Filename | Overview |
|---|---|
| packages/bitbadgesjs-sdk/openapitypes-helpers/routes.yaml | Fixes typo Miscellanous → Miscellaneous 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 ✓"]
Reviews (1): Last reviewed commit: "docs(openapi): fix Miscellanous typo, de..." | Re-trigger Greptile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two small tag-consistency issues that surface in the Stoplight-rendered public reference:
Typo'd tag on
/status— it's taggedMiscellanous(missing thee), while the top-leveltags:list declaresMiscellaneous. Stoplight treats these as distinct groups, so/statusends up under a typo'd section instead of the intended Miscellaneous bucket.Undeclared
Maps and Protocolstag — four routes (/maps,/maps/{mapId},/mapValues,/mapValue/{mapId}/{key}) are grouped underMaps and Protocolsbut the tag is never declared at the top level, so Stoplight renders them as an untitled/undescribed group.Fix:
Miscellanous->Miscellaneouson/statusMaps and Protocolsto the top-leveltags:list with a one-line descriptionTest plan
/statusrenders under Miscellaneous and the Maps and Protocols group has its description.Generated by the docs-watch agent (daily OpenAPI quality sweep).