feat(openapi): a fresh coat of paint on `openapi inspect` #1127

erunion · 2024-12-21T05:57:35Z

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

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

Consistent table widths. _{existential grumbling}
Table headers are now yellow instead of green to reduce the amount of color thrashing we have going on.
URLs to OpenAPI spec definitions our own docs are now dimmed instead of grey.
Tossed an emoji on the different feature sections. 🌲 for OpenAPI and 📖 for us.
Swapped out the ✅ emoji for used features in place of 🟢 and 🔴 circles.
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.
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:

erunion · 2024-12-21T05:59:45Z

src/commands/openapi/inspect.ts

+          let msg: string;
+          msg = `You have a total of ${chalk.bold(info.found)} ${pluralize(info.name.toLowerCase(), info.found)} in your API.`;
+          if (info.found > 100) {
+            msg += ` ${chalk.cyanBright('Wow! 🤯')}`;


iffy on the emoji but thought it might be fun for the true Big API sickos if this stood out a bit more. also might bump this 100 operation threshold up to maybe 200 because after this week of debugging failed API uploads 100 operations in a single file seems so small

obsessed with this

ended up bumping this up to 200

erunion · 2024-12-21T06:00:38Z

src/commands/openapi/inspect.ts

    report.push(
      table(tableData, {
        border: tableBorder,
        columns: {
+          0: {
+            width: 26,


This caps the "Feature" table column to a specific width, which because the second "Used" one doesn't have variable content, causes the width of every table to now be identical.

src/commands/openapi/inspect.ts

kanadgupta · 2024-12-29T20:22:13Z

src/commands/openapi/inspect.ts

+          let msg: string;
+          msg = `You have a total of ${chalk.bold(info.found)} ${pluralize(info.name.toLowerCase(), info.found)} in your API.`;
+          if (info.found > 100) {
+            msg += ` ${chalk.cyanBright('Wow! 🤯')}`;


obsessed with this

Co-authored-by: Kanad Gupta <[email protected]>

# [10.1.0-next.2](v10.1.0-next.1...v10.1.0-next.2) (2025-01-06) ### Features * **openapi:** a fresh coat of paint on `openapi inspect` ([#1127](#1127)) ([ff8c304](ff8c304)) [skip ci]

kanadgupta · 2025-01-06T18:50:29Z

🎉 This PR is included in version 10.1.0-next.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

## 🧰 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]>

* **openapi:** a fresh coat of paint on `openapi inspect` ([#1127](#1127)) ([ff8c304](ff8c304)) [skip ci]

## 🧰 Changes reapplies the following changes from the `next` branch onto the `v9` branch: - [x] #1124 - [x] #1125 - [x] #1126 - [x] #1127 - [x] #1143 - [x] #1144 - [x] #1141 ## 🧬 QA & Testing do tests pass? --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Jon Ursenbach <[email protected]> Co-authored-by: semantic-release-bot <[email protected]> Co-authored-by: Jon Ursenbach <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

erunion added 2 commits December 20, 2024 20:35

feat(openapi): oas tooling upgrades

eec3c57

feat(openapi): a fresh coat of paint on openapi inspect

c608311

erunion added enhancement New feature or request command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands labels Dec 21, 2024

erunion commented Dec 21, 2024

View reviewed changes

erunion marked this pull request as ready for review December 21, 2024 06:01

erunion requested a review from kanadgupta December 21, 2024 06:01

kanadgupta approved these changes Dec 29, 2024

View reviewed changes

erunion and others added 3 commits December 29, 2024 12:24

Update inspect.ts

26433e3

Co-authored-by: Kanad Gupta <[email protected]>

fix: test snapshot

466647f

fix: bumping up the sicko threshold to 200 operations

4d064e0

domharrington approved these changes Jan 6, 2025

View reviewed changes

kanadgupta approved these changes Jan 6, 2025

View reviewed changes

Base automatically changed from feat/openapi-tooling-upgrades to next January 6, 2025 18:39

Merge branch 'next' into feat/inspect-coat-of-paint

c0a104b

erunion merged commit ff8c304 into next Jan 6, 2025
8 checks passed

erunion deleted the feat/inspect-coat-of-paint branch January 6, 2025 18:47

kanadgupta added the released on @next label Jan 6, 2025

kanadgupta pushed a commit that referenced this pull request Jan 6, 2025

build(release): 🚀 v10.1.0-next.2 🦉

3b6d3d2

* **openapi:** a fresh coat of paint on `openapi inspect` ([#1127](#1127)) ([ff8c304](ff8c304)) [skip ci]

kanadgupta mentioned this pull request Jan 6, 2025

feat(v9): backport openapi tooling etc. from v10 #1145

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(openapi): a fresh coat of paint on `openapi inspect` #1127

feat(openapi): a fresh coat of paint on `openapi inspect` #1127

erunion commented Dec 21, 2024 •

edited

Loading

erunion Dec 21, 2024

kanadgupta Dec 29, 2024

erunion Jan 3, 2025

erunion Dec 21, 2024

kanadgupta Dec 29, 2024

kanadgupta commented Jan 6, 2025

feat(openapi): a fresh coat of paint on openapi inspect #1127

feat(openapi): a fresh coat of paint on openapi inspect #1127

Conversation

erunion commented Dec 21, 2024 • edited Loading

🧰 Changes

🧬 QA & Testing

erunion Dec 21, 2024

Choose a reason for hiding this comment

kanadgupta Dec 29, 2024

Choose a reason for hiding this comment

erunion Jan 3, 2025

Choose a reason for hiding this comment

erunion Dec 21, 2024

Choose a reason for hiding this comment

kanadgupta Dec 29, 2024

Choose a reason for hiding this comment

kanadgupta commented Jan 6, 2025

feat(openapi): a fresh coat of paint on `openapi inspect` #1127

feat(openapi): a fresh coat of paint on `openapi inspect` #1127

erunion commented Dec 21, 2024 •

edited

Loading