Skip to content

Developer documentation

API reference

Reference material for versioned public operations, authentication, response schemas, provenance, errors and stability.

Reference material will be published alongside the first public API release.

The OpenDeco API is not intended for real-time decompression control, dive planning or other safety-critical operation.

One source of truth

The reference describes published behavior. It does not expose internal browser calls or document operations before their public contract exists.

Contract source

Operation pages are generated from a versioned OpenAPI contract. Explanations and examples remain source-controlled and are tested against that contract.

Scientific provenance

Responses that represent scientific records identify the relevant dataset, model, release or artifact version. A value should be traceable to the record that produced it.

Access boundary

Released research metadata remains public where practical. Account-linked data and application management require authentication and explicit scopes.

Change policy

Breaking changes receive a new version. Deprecations state the replacement, migration path and supported transition period.

Every operation answers the same questions

  1. Purpose and stability
  2. Authentication and scopes
  3. Request parameters
  4. Response schema
  5. Provenance fields
  6. Example request
  7. Example response
  8. Errors
  9. Version and migration notes