knuckleswtf / scribe

Generate API documentation for humans from your Laravel codebase.✍
https://scribe.knuckles.wtf/laravel/
MIT License
1.58k stars 280 forks source link

Always ask to remove external.html_attributes.* on scribe:generate for no reason #845

Closed max13fr closed 1 month ago

max13fr commented 1 month ago

Scribe version

4.35

PHP version

8.2.18

Framework

Laravel

Framework version

11.5.0

Scribe config

type => "external_laravel"
theme => "elements"
external.html_attributes.apiDescriptionUrl => "/docs.openapi"
external.html_attributes.basePath => "/docs"
external.html_attributes.layout => "responsive"
external.html_attributes.router => "hash"
external.html_attributes.tryItCredentialsPolicy => "same-origin"
auth.enabled => true
auth.default => true
auth.name => "Authorization"
examples.faker_seed => 666

What happened?

Hello,

To use Elements, I need to set external.html_attributes, mainly to fix a current issue with laravel mode (#813) but also for some customization.

I followed the scribe documentation (https://scribe.knuckles.wtf/laravel/reference/config#external), but everytime I run php artisan scribe:generate, the update process ask me to remove html_attributes, it's really annoying.

I'm on new fresh install of Scribe & laravel, so need to run any update part. Am I missing something ?

Thanks in advance, Best regards, Max

✔ Wrote Laravel assets to: public/vendor/scribe/
Checking for any pending upgrades to your config file...

You're using an updated version of Scribe, which added new items to the config file.
Here are the changes:
- `external.html_attributes.apiDescriptionUrl` will be removed.
- `external.html_attributes.basePath` will be removed.
- `external.html_attributes.layout` will be removed.
- `external.html_attributes.router` will be removed.
- `external.html_attributes.tryItCredentialsPolicy` will be removed.

 Let's help you update your config file. Accept changes? (yes/no) [no]:

Docs

shalvah commented 1 month ago

Oh, that's an oversight. FIxing in a bit. Thanks for the report.

max13fr commented 1 month ago

Thanks !