Show property-level examples next to param descriptions

Open Beginner friendly
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

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.

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.

Dominant language
Jupyter Notebook
Stars
5
Forks
4
Avg merge
2d 47m
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/fastspec

All issues in AnswerDotAI/fastspec

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.