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

In the response field description the text do not wrap (default theme issue) #930

Open
1 task done
niranjanbai opened this issue Dec 25, 2024 · 1 comment
Open
1 task done
Labels
bug Something isn't working help wanted Contributions from the community are encouraged ui (wontfix)

Comments

@niranjanbai
Copy link

Scribe version

4.32.0

PHP version

8.1.19

Framework

Laravel

Framework version

10.45.1

Scribe config

static.output_path => "public/docs/api-docs/beta/v1"
try_it_out.enabled => false
auth.enabled => true
auth.default => true
auth.name => "token"
logo => "/img/g2g-api-logo.png"
strategies.metadata => removed Knuckles\Scribe\Extracting\Strategies\Metadata\GetFromMetadataAttributes
strategies.urlParameters => added Knuckles\Scribe\Extracting\Strategies\UrlParameters\GetFromLumenAPI: removed Knuckles\Scribe\Extracting\Strategies\UrlParameters\GetFromUrlParamAttribute
strategies.queryParameters => removed Knuckles\Scribe\Extracting\Strategies\QueryParameters\GetFromQueryParamAttribute
strategies.headers => added Knuckles\Scribe\Extracting\Strategies\Headers\GetFromRouteRules: removed Knuckles\Scribe\Extracting\Strategies\Headers\GetFromHeaderAttribute, [
    'override',
    [
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
    ],
]
strategies.bodyParameters => added App\Docs\Strategies\HiddenFormRequestParameters, App\Docs\Strategies\SortQueryAndBodyParameters: removed Knuckles\Scribe\Extracting\Strategies\BodyParameters\GetFromBodyParamAttribute
strategies.responses => added Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls: removed Knuckles\Scribe\Extracting\Strategies\Responses\UseResponseAttributes, [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
    ],
]
strategies.responseFields => removed Knuckles\Scribe\Extracting\Strategies\ResponseFields\GetFromResponseFieldAttribute

What happened?

I am using the default theme.
The field description text in the API response area on the page does not break (word wrap) at word boundaries. Rather the text continue to appear in the example code area.
Example

Note: Text is correctly word-wrapped on Headers, Body Parameters, etc., in the Request area.

Docs

@niranjanbai niranjanbai added bug Something isn't working triage labels Dec 25, 2024
@shalvah shalvah removed the triage label Jan 19, 2025
@shalvah
Copy link
Contributor

shalvah commented Jan 19, 2025

Thanks for the report. I probably won't be fixing this any time soon, as the UI part is the worst part of maintaining Scribe for me. I'm currently working on prepping the next major, and it's likely I'll change the default settings to external, so that UI is handled by other projects, which are good at that. Alternatively, if you can make a contribution to fix it yourself, that would be welcome.

@shalvah shalvah added ui (wontfix) help wanted Contributions from the community are encouraged labels Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Contributions from the community are encouraged ui (wontfix)
Projects
None yet
Development

No branches or pull requests

2 participants