Thank you for helping improve this specification. Accurate API docs make everyone's life easier.
- Bug fixes — wrong parameter name, incorrect type, missing
nullable, wrong endpoint path. - Missing fields — a response field that exists in the real API but isn't in the schema.
- New endpoints — if Datalastic releases a new endpoint not yet covered.
- Better descriptions — clearer wording, additional context, corrected units.
- New examples — additional curl/Python/JavaScript examples.
-
Fork this repo and create a branch:
git checkout -b fix/vessel-history-date-params
-
Edit
openapi.yaml(or files inexamples/). -
Validate before opening a PR:
npm install -g @redocly/cli redocly lint openapi.yaml
The CI will also run this automatically.
-
Open a PR with a clear title and description explaining what was wrong and what the correct value is. If you have a link to the Datalastic docs that confirms the fix, include it.
- Keep descriptions concise — one or two sentences max per field.
- Always mark fields
nullable: trueif the API can returnnull. - Use
format: dateforyyyy-mm-ddstrings,format: date-timefor full ISO 8601 timestamps. - Endpoint-level descriptions should include the credit cost and any important constraints (max radius, max window, etc.).
- Real example values are always preferred over placeholder strings.
Open a GitHub issue with:
- The endpoint path
- The parameter or field name
- What the spec currently says
- What the real API actually returns (paste the JSON if possible)
Email support@datalastic.com for questions about the API itself. Open an issue here for anything spec-related.