AnswerDotAI / AnswerDotAI/fastspec
Show property-level examples next to param descriptions
- Dominant language
- Jupyter Notebook
- Stars
- 5
- Forks
- 4
- Avg merge
- 2d 47m
- Merged PRs (30d)
- 4
Description
Properties inside a request schema often carry `example`/`examples` (a sample value for that one field, not a whole request). These are currently dropped, and can't safely be assembled into a full payload — but they're useful inline.
Follow-up: in `mk_doc`, append `(example: value)` after each param description when the property has one.
Coverage scan: Cloudflare has 608 body ops with *only* property-level examples (47%); OpenAI 15; Anthropic 5.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start at the `mk_doc` entry point and trace how request-schema properties become parameter descriptions. Preserve each property's individual `example` or `examples` value as inline text without assembling a full request payload. Done means generated documentation shows `(example: value)` after descriptions for properties that provide one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100