Skip to main content
Developers

Use the OpenAPI document

Download the original contract, understand the reference scope, and account for missing export metadata.

3 min read

Download the source

Download the unchanged supplied OpenAPI JSON or OpenAPI YAML. Both describe Dashio API 2026.8.0, using OpenAPI 3.1.0.

The API reference renders all 131 HTTP operations whose paths begin with /api/v1/. The source files also contain application and internal Nuxt routes. Internal framework routes are not integration endpoints and are excluded from the browsable reference.

Choose an API origin

The source’s only server URL is https://www.dashio.local:3000, labeled as local development. It has been preserved in the downloads.

Reference request examples use the configured API origin, which defaults to https://dashio.net. Override the documentation deployment’s NUXT_PUBLIC_API_BASE_URL to generate examples for another deployment. When generating a client, configure its base URL explicitly rather than sending production requests to the local URL in the export.

Review authentication metadata

Some operations reference bearerAuth, but the source has no components.securitySchemes definition. Supply the correct scheme configuration in your client tooling and arrange authorized credentials for the target deployment.

An operation without a security declaration is shown as undocumented authentication. The reference does not interpret that omission as public access.

Understand generated examples

Where the document supplies an example, the reference uses it. Otherwise, a declared schema can produce a structural example. These generated examples use placeholders and are labeled; they are not responses captured from a running service.

A response without a body schema or example remains description-only. Required fields, nullable values, nested arrays and objects, and declared HTTP statuses come from the source.

Account for newer features

The supplied export predates some features in the current website. End-user guides can describe production-enabled email signatures even though their newer marketing endpoints are absent from this export. Use a refreshed authoritative contract before generating clients for endpoints that are not present here.