knuckleswtf / knuckleswtf/scribe

Private information doesnt expected at public docs

Open
#974 5 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
PHP
Stars
2.3k
Forks
357
PR merge metrics
No merged PRs in 30d

Description

### Scribe version

4.40.0

### Your question

Name of tables or models doesnt expected at public docs.

If we have request like this:
```php
/**
* Query parameters.
*/
class SecureRequest extends FormRequest
{
public function rules(): array
{
return [
'request_key' => 'nullable|string|exists:'.SecureModel::class.',secure_column'
];
}

public function queryParameters(): array
{
return [
'request_key' => ['description' => 'Your access key'],
];
}
}
```

Scribe generate something like that:

> **request_key** string optional.
> Your access key. **The secure_column of an existing record in the App\Models\Secure table.**

but expected anoter result:

> **request_key** string optional.
> Your access key.
>

And now we cant disable this secure information.

### Docs

- [x] I've checked [the docs](https://scribe.knuckles.wtf/laravel), the [troubleshooting guide](https://scribe.knuckles.wtf/laravel/troubleshooting), and [existing issues](https://github.com/knuckleswtf/scribe/issues?q=is%3Aissue+), but I didn't find a solution

Contributor guide

Open the contributing guide

Research direction

Reproduce the issue with the shown SecureRequest FormRequest and inspect the generated API documentation for the request_key rule. Trace the Scribe documentation generation path that turns the exists rule into explanatory text; done means the user description remains while the table, model, and column details are omitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, php
Domain
documentation, security
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.