knuckleswtf / knuckleswtf/scribe

Hide list of enums from Rules::in validation (BodyParameters)

Open
#940 2 comments 0 reactions 0 assignees View on GitHub
awaiting requester action question
Dominant language
PHP
Stars
2.3k
Forks
357
PR merge metrics
No merged PRs in 30d

Description

### Scribe version

4.39.0

### Your question

I have a very long list (hundreds) of items in Rule::in().
I would like to hide the "Must be one of" in the generated docs, but I can not find a way to do this.
Did I miss anything?

Using the FormRequest variant:

```

*/
public function rules(): array
{
return [
'records.*.data.*.descriptor' => [ 'required', 'string', Rule::in( Descriptor::getAllUids() ) ],
];
}
/**
* Documentation for Scribe API documentary.
*
* @return array[]
*/
public function bodyParameters(): array
{
return [
'records.*.data.*.descriptor' => [
'description' => 'UID of the descriptor.',
'example' => '0.0.NTSCD55',
],
];
}
```

![Image](https://github.com/user-attachments/assets/e371b88d-3cc2-4cc5-a764-24c04d2c18f2)

### 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

Start by tracing how the FormRequest bodyParameters entry and Rule::in(Descriptor::getAllUids()) are represented in the generated documentation. Identify the existing extension or configuration path for validation-rule output, then verify that the enum list can be suppressed while the field description and example remain documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, php
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.