Skip to content

fix(api-reference): improve wrapping of long strings #7252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix(api-reference): improve wrapping of long strings #7252

wants to merge 5 commits into from
+464 −319

Conversation

@hwkr
Copy link
Contributor

@hwkr hwkr commented Nov 4, 2025 •
edited
Loading

Improves wrapping of long strings using the same methods as in the sidebar. Should have minimal affect on current rendering of shorter strings give or take some pixel shift.

Need to sync with @cameronrohani on some of the spacing.

Parameter Names

Before

CleanShot 2025-11-03 at 19 46 55@2x

After

CleanShot 2025-11-03 at 19 47 15@2x

Responses

This moves the response description to be below the title when the response is open so it has more room and doesn't collide with the content type dropdown.

Before

CleanShot 2025-11-03 at 19 37 37@2x CleanShot 2025-11-03 at 19 43 39@2x

After

CleanShot 2025-11-03 at 19 34 58@2x CleanShot 2025-11-03 at 19 35 12@2x

Enums Before + After

CleanShot 2025-11-03 at 18 20 21@2x CleanShot 2025-11-03 at 18 19 53@2x

Checklist

I've gone through the following:

  • I've added an explanation why this change is needed.
  • I've added a changeset (pnpm changeset).
  • I've added tests for the regression or new feature.
  • I've updated the documentation.

@changeset-bot
Copy link

changeset-bot bot commented Nov 4, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: da57f73

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025 •
edited
Loading

Preview Examples

https://ec40895c-a394-49ab-9686-2d1e346dc4ab--scalar-deploy-preview.netlify.app

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025 •
edited
Loading

Preview Storybook

https://c9084579-db91-4fd6-b59a-d6b170d1c0d2--scalar-components.netlify.app

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025 •
edited
Loading

Scalar References End to End Test Results

failed  2 failed
passed  64 passed

Details

report  Open report ↗︎
stats  66 tests across 30 suites
duration  20.6 seconds
commit  da57f73

Failed tests

test/snapshots/models.e2e.ts › Scalar Galaxy
test/snapshots/operations.e2e.ts › Scalar Galaxy

Important

These tests include snapshots that may need to be updated if there are intentional changes to the UI components. To update the snapshots run pnpm test:e2e:update in packages/api-reference and commit the changes.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025 •
edited
Loading

Scalar Components Snapshot Test Results

passed  152 passed

Details

report  Open report ↗︎
stats  152 tests across 19 suites
duration  45.2 seconds
commit  da57f73

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025 •
edited
Loading

Scalar CDN Snapshot Diff Results

failed  14 failed
passed  6 passed

Details

report  Open report ↗︎
stats  20 tests across 1 suite
duration  9.7 seconds
commit  da57f73
info  These tests are non-blocking and will not prevent merging of your PR.

Failed tests

test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Scalar Galaxy
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Scalar Galaxy Registry
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Stripe
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Long Strings Example
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Swagger Petstore 3.0
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Swagger Petstore 3.1
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Valtown
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Zoom
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Cloudinary
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Tailscale
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Maersk
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Bolt
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - OpenStatus
test/snapshots-cdn/snapshot.e2e.ts › Diff with CDN - Spotify

Important

These tests detect visual differences between the current PR and the latest CDN build which means they may be affected by other changes in main that haven't been released yet.

They can help determine if the changes in the PR are causing any unexpected visual regressions but may be less helpful in isolating the exact cause. For more details see the readme.

@hwkr hwkr force-pushed the brynn/doc-4366-long-strings branch from 4c4c348 to da57f73 Compare November 5, 2025 04:45
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

Cloudflare Preview for the API Client

https://348020ed.client-staging-7m0.pages.dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marclave marclave Awaiting requested review from marclave marclave is a code owner

@hanspagel hanspagel Awaiting requested review from hanspagel hanspagel is a code owner

@amritk amritk Awaiting requested review from amritk amritk is a code owner

@geoffgscott geoffgscott Awaiting requested review from geoffgscott geoffgscott is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hwkr