Skip to content

Show endpoint descriptions on Machines API pages - #2583

Merged
NullHypothesis merged 1 commit into
mainfrom
show-api-endpoint-descriptions
Oct 19, 2026
Merged

NullHypothesis merged 1 commit into
mainfrom
show-api-endpoint-descriptions

Conversation

@NullHypothesis

Copy link
Copy Markdown
Contributor

The rule that hides the description subtitle on regular pages also hid the OpenAPI operation description on every Machines API endpoint page. Skip pages that contain Mintlify's API operation container.

The rule that hides the description subtitle on regular pages also hid
the OpenAPI operation description on every Machines API endpoint page.
Skip pages that contain Mintlify's API operation container.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
fly-io 🟢 Ready View Preview Oct 19, 2026, 3:35 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@NullHypothesis

Copy link
Copy Markdown
Contributor Author

@kcmartin, I believe #2551 was meant to hide descriptions but not OpenAPI descriptions, right? For example, the "destroy machine" page doesn't show the description today:

image

...but it should look like this:

image

If we want OpenAPI descriptions, this PR should make that possible by using a more specific CSS selector.

@kcmartin

Copy link
Copy Markdown
Contributor

@kcmartin, I believe #2551 was meant to hide descriptions but not OpenAPI descriptions, right?

Thanks for finding this! Yes, the intention was to hide the subtitle so descriptions are for search only, and this was an unintended consequence. I checked the preview: endpoint descriptions show on both Machines and Sprites API pages, and regular pages still hide the subtitle. Approving. Thanks again!

@kcmartin kcmartin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for finding this!

@NullHypothesis
NullHypothesis merged commit dc98246 into main Oct 19, 2026
2 checks passed
@NullHypothesis
NullHypothesis deleted the show-api-endpoint-descriptions branch October 19, 2026 16:57

This branch was successfully deployed

1 active deployment
staging — 304258f4 Deployed Oct 19, 2026 by mintlify[bot]
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