Skip to content

write-tech-spec: add API usage examples section for public API specs#33

Open
warp-dev-github-integration[bot] wants to merge 1 commit into
mainfrom
oz-agent/write-tech-spec-api-usage-examples
Open

write-tech-spec: add API usage examples section for public API specs#33
warp-dev-github-integration[bot] wants to merge 1 commit into
mainfrom
oz-agent/write-tech-spec-api-usage-examples

Conversation

@warp-dev-github-integration

Copy link
Copy Markdown

Summary

Adds an API usage examples optional section to the write-tech-spec skill. When a tech spec introduces or modifies a public API, the agent is now instructed to include this section with:

  • A raw HTTP example (method, path, headers, request body, annotated response) usable without any SDK
  • SDK examples for any officially supported SDKs (e.g. Python, TypeScript), matched to the version documented in the codebase or specs
  • At least one composition example showing how this API interacts with related APIs in the same set — e.g. a workflow that creates a resource with one endpoint and uses it in another

Examples should be minimal but realistic, with plausible values and annotations on non-obvious fields. If an OpenAPI spec exists, examples must match it exactly.

Conversation: https://staging.warp.dev/conversation/66820165-9189-4a66-a633-5ca2e5df2a62
Run: https://oz.staging.warp.dev/runs/019efb1d-3ca2-7ec7-8d60-a90b80bb0061

This PR was generated with Oz.

When a spec introduces or modifies a public API, the agent should now
include an 'API usage examples' optional section with:
- Raw HTTP examples (method, path, headers, body, annotated response)
- SDK examples for any officially supported SDKs
- At least one composition example showing how the API chains with
  other APIs in the same set

Co-Authored-By: Oz <oz-agent@warp.dev>
@captainsafia
captainsafia marked this pull request as ready for review June 24, 2026 19:33
@captainsafia
captainsafia requested a review from vorporeal June 24, 2026 19:34
@oz-for-oss

oz-for-oss Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

@captainsafia

I ran into an unexpected error while working on this.

Powered by Oz

@vorporeal vorporeal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could i get an example? (did you evaluate this at all?) it's hard to get a sense for whether or not this produces high-SNR info.

for example, it says "at least one end-to-end example for each major operation", which i worry will lead to a lot of low-value examples of "create object", "get object", etc.

At least one composition example showing how this API interacts with related APIs in the same set — for instance, a sequence that creates a resource with one endpoint and then uses it in another, or a workflow that chains multiple calls.

this is what i think is the valuable thing here, much moreso than any individual API call. how do these APIs fit together to support the product flows? is the system robust to failures at any point in a sequence of API calls?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants