@vwala/platform-energy-openapi

The OpenAPI 3.1 schema (JSON) and generated TypeScript types for the Vwala Energy Platform API — the public, self-serve energy API at https://open-energie.api.vwala.be/.

This package is generated from the running service; do not edit it by hand.

Install

npm install @vwala/platform-energy-openapi

Usage

TypeScript types

import type { paths, components, operations } from "@vwala/platform-energy-openapi";

// e.g. the response body of `GET /v1/...`
type ApiKey = components["schemas"]["ApiKey"];

The types are produced by openapi-typescript, so the exports are paths, webhooks, components, operations, and $defs. Pair them with a typed client such as openapi-fetch.

Raw JSON schema

import spec from "@vwala/platform-energy-openapi/openapi.json";

Use the JSON for codegen, request/response validation, mock servers, or rendering docs.

Versioning

This package follows semantic versioning, derived from the actual API diff. On each production release, the schema is compared against the previously published version with oasdiff:

| Change in the schema | npm version bump | | ----------------------------------------- | ---------------- | | Breaking (e.g. a removed field/endpoint) | major | | Backward-compatible addition | minor | | Other non-breaking change (docs, etc.) | patch |

Breaking changes are caught in CI and must be reviewed before they can merge, so a major bump is always a deliberate, reviewed event.

Note: the npm package version tracks this schema package. The OpenAPI document's own info.version field is the API contract version and is versioned separately — the two numbers are not expected to match.