Skip to content

Commit

Permalink
feat(openapi): a fresh coat of paint on openapi inspect (#1127)
Browse files Browse the repository at this point in the history
## 🧰 Changes

The biggest problem I've had since originally building our `openapi
inspect` command has been that the tables between OpenAPI and ReadMe
features aren't of consistent widths. Drives me up a damn wall.

<img width="1309" alt="Screenshot 2024-12-20 at 9 50 05 PM"
src="https://github.com/user-attachments/assets/2cfc1dd6-9bd8-4c1c-bed4-7d627d26e2d0"
/>

So I'm giving a fresh coat of paint to this command that deserves some
love.

* [x] Consistent table widths. <sub>existential grumbling</sub>
* [x] Table headers are now yellow instead of green to reduce the amount
of color thrashing we have going on.
* [x] URLs to OpenAPI spec definitions our own docs are now dimmed
instead of grey.
* [x] Tossed an emoji on the different feature sections. 🌲 for OpenAPI
and 📖 for us.
* [x] Swapped out the ✅ emoji for used features in place of 🟢 and 🔴
circles.
* [x] Usage strings like "2 Media Types", "a total of 9 Operations", or
"a single Security Type" are now lowercased because it looked funky as
hell.
* [x] Bumped OpenAPI spec links to the latest versions for 3.0 and 3.1.

I also made a couple minor readability to how we construct this table
because the code was a bit gnar with some deeply nested `array.push()`
calls.

## 🧬 QA & Testing

This is what it all looks like:

<img width="1426" alt="Screenshot 2024-12-20 at 9 42 57 PM"
src="https://github.com/user-attachments/assets/99028b5d-85a6-423e-a578-b4c095ca0cee"
/>

---------

Co-authored-by: Kanad Gupta <[email protected]>
  • Loading branch information
erunion and kanadgupta authored Jan 6, 2025
1 parent fb1f8ba commit ff8c304
Show file tree
Hide file tree
Showing 5 changed files with 395 additions and 397 deletions.
Loading

0 comments on commit ff8c304

Please sign in to comment.