Scalar theme doesn't use data from ResponseField attribute.

[ravibpatel]

Scribe version

4.38.0

PHP version

8.3

Framework

Laravel

Framework version

11.33.2

Scribe config

type => "laravel"
auth.enabled => true
auth.default => true
auth.name => "Authorization"
examples.faker_seed => 2
strategies.bodyParameters => added App\GetFromFormRequest: removed Knuckles\Scribe\Extracting\Strategies\BodyParameters\GetFromFormRequest

What happened?

When using "scalar" theme with "external_laravel" type, it doesn't populate the values from ResponseField attribute in the docs. It works fine with default theme.

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Does the data show up in the generated OpenAPI spec though? Because the data that shows up in the external_* themes is an external JS library (eg Scalar) which takes the OpenAPI spec. So if it's in the OpenAPI spec but not rendered by the external library, it's not on us.

[ravibpatel]

I checked the OpenAPI spec, and it has the response fields for some of the endpoints, but not for others. Those who have the response fields does show up in scalar.

[ravibpatel]

It seems it is calling the setDescription method using the full path here and that is causing the issue. I have added ResponseField attribute to ApiResource with id as the name as mentioned here, but it is looking for data.id.