Skip to main content

Schema coverage

This reference is generated from the MineTech API's own OpenAPI specification. Request parameters and bodies are documented throughout. Response schemas are still being added, and operations without one are marked:

Success. The response schema for this operation is not yet documented.

Why the gap is shown rather than hidden​

Two alternatives were rejected:

  • Invent a schema. The docs would look complete and be wrong, and the SDK would assert return types the API does not guarantee. A confidently incorrect type is worse than an honest unknown.
  • Omit the operation. The endpoint exists and works; hiding it because its response is undocumented would make the reference incomplete in a way you could not detect.

So the gap is advertised. You can see exactly which operations are affected, and it shrinks every release.

Working with an undocumented response​

The endpoint returns real, stable data — only the published schema is missing. Inspect a response and narrow at the call site:

const lot = (await client.operations.lots.get(id)) as {
  id: string;
  grade: number;
};

When the schema lands, the regenerated spec tightens the type automatically. Your narrowing keeps working; you can delete it when convenient.

Current state​

Machine-readable, regenerated with every spec build: specs/coverage-report.json.

It breaks coverage down per tag, so the modules you depend on can be prioritised. If a specific operation is blocking you, email engineering@minetech.rw with the operationId — targeted requests get done first.