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

[gsusanj]

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:

<?php
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array<string, mixed>
     */
    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',
            ],
        ];
    }

Docs

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

[shalvah]

Hmm, you could disable the FormRequest strategy, or replace it with a custom strategy that ignores the rule.

Alternatively, we can add a check to not include this description if the items are above a certain count, but there are some considerations:

• How many is "too many"? 10? 20? It's quite arbitrary.
• What about OpenAPI spec and Postman collection? Do we show all there?

What do you think?