knuckleswtf / knuckleswtf/scribe
only name & example supported in the header
- Dominant language
- PHP
- Stars
- 2.3k
- Forks
- 357
- PR merge metrics
- No merged PRs in 30d
Description
### Scribe version
4.35.0
```
scribe.php
'type' => 'static',
'theme' => 'elements',
```
### Your question
I found that there are no extensions GenericParam in the header, only name and example are supported.
I speculate that it may be due to certain reasons or scenarios, such as encountering unpredictable errors when generating OpenAPI Specifications and Postman Collections. But I think we can try debugging it.
Of course, I am just discussing this topic. If you need me to contribute to this part of the design, I can take some time to organize my PR. Currently, I am trying to run it on my project and have not found any abnormal scenarios. If you are interested, please refer to:
I found that there are still quite a few areas that need to be debugged, and it should be adapted to various themes.
### 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
Research direction
Start with the scribe.php configuration and trace how header GenericParam values are handled when generating OpenAPI Specifications and Postman Collections. Compare the current name and example support across the available themes, then define the extensions and scenarios to support before validating that generated outputs remain correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- laravel, php
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100