Skip to main content
API reference

Generated Reference

What the published OpenAPI document describes, rendered in full — and what it does not.

3 min read
View MarkdownEdit on GitHub

Generated Reference

These pages are generated from CodeSpar's published OpenAPI document — the same one served at https://api.codespar.dev/openapi.json without a credential — and cover all 213 operations it describes, across 46 resource groups.

What this is not

It is not the whole product surface. The OpenAPI document describes part of the API, and this reference is complete only with respect to that document. Anything the document does not describe is absent here — silently, because a generator cannot report what its input never mentioned. When you cannot find an operation on these pages, the right conclusion is "the spec does not describe it yet", not "it does not exist".

The hand-written pages under API Reference are the other half. They carry narrative, field rules, and worked flows, and several of them document surfaces the spec has never described. Neither set replaces the other, and the generated ones never overwrite the written ones — they live in this subtree for exactly that reason.

About the examples

Every example on these pages is synthesised from the schema, not captured from a real call. The published document carries no example values, so what you see is a body of the right SHAPE with placeholder contents: the field names, the nesting and the enum choices are real, the values are not. Ids are shown with this product's own prefixes so the shape reads correctly, but no id here ever existed.

Use them to see which field goes where. Do not use them as fixtures, and do not read a value as a supported one unless it comes from an enum, which the field tables mark.

How it stays current

Pages are generated from a snapshot committed at scripts/api-reference/openapi-snapshot.json, not from the live endpoint, so the freshness check runs without a network call and cannot pass because a proxy answered. Refreshing the snapshot is a separate, reviewable commit.

Spec version at generation time: 0.3.0.

Pages

Generated Reference | CodeSpar