Skip to content
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.

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

Openapi: improve generated docs headings title formatting #1494

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

easwee
Copy link

@easwee easwee commented Feb 26, 2025

Current issue:

Openapi docs params and body titles are hard-coded as "Title Case" strings.
image

We do not use title-case anywhere because of readability issues it brings (it is a discouraged formatting). It would be nice to have an option to configure the formatting, or allow for custom string - not hard-coded.

I'm willing to implement some kind of localization or at least dynamic string insertion for this - if you already have a preferred way of doing it, please advise.

Copy link

changeset-bot bot commented Feb 26, 2025

⚠️ No Changeset found

Latest commit: c9908c4

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

Copy link

vercel bot commented Feb 26, 2025

@easwee is attempting to deploy a commit to the Fuma Team on Vercel.

A member of the Team first needs to authorize it.

@easwee easwee marked this pull request as draft February 26, 2025 14:45
@easwee easwee changed the title WIP: Openapi: improve generated docs headings title formatting Openapi: improve generated docs headings title formatting Feb 26, 2025
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.

1 participant