AnswerDotAI / AnswerDotAI/fastspec

Fall back to schema-root example(s) for body examples

Open Beginner friendly
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
5
Forks
4
Avg merge
2d 47m
Merged PRs (30d)
4

Description

#30 surfaces media-type-level `examples`/`example` in op docs. Some specs (e.g. Anthropic's `POST /v1/messages`) instead put a complete whole-payload example *inside* the root request schema (`schema.example` in 3.0, `schema.examples` array in 3.1) — currently dropped.

Follow-up: in `_body_params`, when the media type has no examples, resolve the schema and read its root `example` (or first of `examples`) as a `{"default": {"value": ...}}` body example. Root-level only — property-level examples are a separate issue.

Coverage scan: Anthropic 5/13 body ops have only this form (incl. `/v1/messages`); GitHub 10; Cloudflare 25.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at `_body_params` and inspect how media-type-level `examples`/`example` are handled and how the request schema is resolved. Done means that, when no media-type examples exist, a root `schema.example` or first `schema.examples` value becomes the default body example, while media-type examples take precedence and property-level examples remain out of scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.