knuckleswtf / scribe

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

@hideFromAPIDocumentation does not work #716

Closed rabol closed 10 months ago

rabol commented 10 months ago

Scribe version

4.23.0

PHP version

8.2.9

Framework

Laravel

Framework version

10.20

Scribe config

type => "laravel"
laravel.docs_url => "/developer/docs"
try_it_out.enabled => false
try_it_out.base_url => "developer/"
auth.enabled => true
auth.default => true
auth.name => "token"
logo => "/img/logo.png"

What happened?

@hideFromAPIDocumentation does not hide the endpoint.


/** @hideFromAPIDocumentation */
Route::middleware(['auth.basic'])->prefix('postmark')->as('postmark.')->group(function () {
    /** @hideFromAPIDocumentation */
    Route::post('/', [PostmarkWebhookController::class, 'handle'])->name('handle');
});

the above is in the final doc

Docs

shalvah commented 10 months ago

It should be on the controller method or class definition.