Skip to content

@W-23748890 feat(query): add QUERY method color badge (OAS 3.2) - #81

Merged
alexpmule merged 2 commits into
mainfrom
W-23748890-query-badge
Aug 19, 2026
Merged

@W-23748890 feat(query): add QUERY method color badge (OAS 3.2)#81
alexpmule merged 2 commits into
mainfrom
W-23748890-query-badge

Conversation

@alexpmule

Copy link
Copy Markdown
Contributor

@W-23748890

What

Adds a color badge for the OAS 3.2 QUERY HTTP method.

@api-components/http-method-label maps the classic verbs (get/post/put/delete/patch/…) plus publish/subscribe, but has no entry for query — so QUERY endpoints fall through to the gray --method-label-default-color. This adds a local CSS override (teal #0F9D9D) keyed on both data-method='query' and data-method='QUERY', mirroring the existing publish/subscribe local-override precedent.

Both casings are covered on purpose: AMF emits apiContract#method="QUERY" (uppercase) verbatim, which api-navigation and api-summary render raw, while api-method-documentation lowercases it via ApiUrl.js.

Why

TD-0333486 — OAS 3.1/3.2 support in API Console v6. AC2: new OAS 3.2 methods must be legible/distinguishable in the console.

Color

Teal / cyan #0F9D9D (bg rgba(15,157,157,0.12)). Read-safe and does not collide with PATCH (purple), GET (green) or POST (blue).

Tests

Green in chromium + firefox. Inline AMF expanded-model fixtures (generator-independent): renders data-method, not lowercased/uppercased incorrectly, _isGrpc false.

Related

Coordinate with Ale Loose's OAS 3.2 operationKind grouping (PR #907) at merge — both touch OAS 3.2, zero code collision.

Scope

Draft for review.

@alexpmule
alexpmule force-pushed the W-23748890-query-badge branch from 1839c23 to 3889dd9 Compare August 18, 2026 22:16
alexpmule and others added 2 commits August 19, 2026 15:27
OAS 3.2 introduces the QUERY HTTP method, which the archived
http-method-label package does not map, so QUERY operations rendered
in the default gray, indistinguishable from unmapped verbs.

Add a local color override for the QUERY method label, mirroring the
existing publish/subscribe overrides. AMF emits apiContract#method as
QUERY (upper case) in navigation, so the rule keys on both 'query' and
'QUERY'. Teal (#0f9d9d) is read-safe and does not collide with the
PATCH purple.

W-23748890
OAS 3.2 introduces the COPY and MOVE HTTP methods alongside QUERY. The
http-method-label palette has no entry for them, so they fall back to the
default gray. Add customizable color hooks matching the QUERY approach:
COPY renders indigo, MOVE renders amber. Both are exposed as CSS custom
properties (--http-method-label-copy/move-color and -background-color)
with sensible fallbacks, and both raw (uppercase) and lower-cased
data-method casings are keyed so navigation and documentation views agree.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@alexpmule
alexpmule force-pushed the W-23748890-query-badge branch from dd52484 to 9d0e206 Compare August 19, 2026 18:27
@alexpmule
alexpmule marked this pull request as ready for review August 19, 2026 20:30
@alexpmule alexpmule self-assigned this Aug 19, 2026
@alexpmule
alexpmule merged commit 51d8a3b into main Aug 19, 2026
3 checks passed
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.

2 participants