knuckleswtf / knuckleswtf/scribe

Avoid generating documentation of an optional body parameters

Open
#894 1 comment 0 reactions 0 assignees View on GitHub
question
Dominant language
PHP
Stars
2.3k
Forks
357
PR merge metrics
No merged PRs in 30d

Description

### Scribe version

4.32.0

### Your question

One of the APIs has a parameter (body parameter) in a form request that is only used for internal purposes. However, it is part of form validation and is an optional parameter. Scribe is used for generating the documentation for external parties.

How do I avoid generating documentation for this parameter?

### 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 with the Laravel documentation and troubleshooting guide linked in the issue, then inspect the existing issues for how form-request parameters are selected for generated documentation. The issue does not name an implementation file or test; done would be a documented, verified way to exclude an optional internal body parameter from the generated API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, php
Domain
api, backend, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.