knuckleswtf / knuckleswtf/scribe
Try it out enable per method
- Dominant language
- PHP
- Stars
- 2.3k
- Forks
- 357
- PR merge metrics
- No merged PRs in 30d
Description
Hi!
I am currently documenting an API and find the "try it out"-function really useful. However, for some methods, i'd prefer to have this function disabled. Especially for methods that redirect to another page (e.g Oauth login page) it's quite annoying because it returns the html of the redirected page.
I saw that for now, there is no way to disable specific methods. It would be very handy to have an option to switch the "try it out" of for a function by a tag (e.g @tryItOut false) of in a custom yaml-file (e.g tryItOut: true).
Contributor guide
Research direction
No files or tests are named in the issue. Start by tracing how per-method “try it out” controls are generated and how method tags or custom YAML configuration are read; done means a method can disable the control through the proposed metadata or configuration and other methods remain enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- laravel, php
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100