Skip to content

docs(dem): document elevation errors and sync its OpenAPI - #174

Merged
shimoncohen merged 3 commits into
masterfrom
docs/elevation-errors
Oct 14, 2026
Merged

shimoncohen merged 3 commits into
masterfrom
docs/elevation-errors

Conversation

@shimoncohen

@shimoncohen shimoncohen commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Brings the elevation page and its OpenAPI in line with dem-heights 3.1.0.

  • Request example with <ELEVATION_SERVICE_URL>/points and the token header.
  • Response: points come back in request order; height: null (no productId) when no height is available; products lists every product; productType is the catalog record's type.
  • Errors section: every errorCode the service returns, plus 401/403 for token errors. POINTS_DENSITY_TOO_LOW_ERROR is dropped — 3.1.0 no longer raises it.
  • Removed the retry-on-timeout note; rephrased the page more formally.
  • OpenAPI: the service's openapi3.yaml at master (3.1.0), plus 401/403, without the unused density error code.

🤖 Generated with Claude Code

…ights 3.0.4

- add a request example, the error codes and the 401/403 token responses
- note null heights outside coverage and that `products` lists every product
- describe `productType` in responses as the catalog record's type
- OpenAPI: take dem-heights 3.0.4's spec (no octet-stream bodies,
  GENERAL_ERROR) and add the 400/401/403 responses and every error code the
  service returns

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-14 13:41 UTC

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
lirantul123
lirantul123 previously approved these changes Oct 11, 2026
@syncush

syncush commented Oct 11, 2026

Copy link
Copy Markdown
Contributor
  1. I dislike the comment about retrying on timeout; remove it.
  2. Please note that the order of point at request is the same order of points in the response.
  3. Ask Claude to check for better phrasing and more formal writing.

asafmas-rnd
asafmas-rnd previously approved these changes Oct 12, 2026
syncush
syncush previously approved these changes Oct 14, 2026
@shimoncohen shimoncohen self-assigned this Oct 14, 2026
- Response points are returned in request order.
- Drop POINTS_DENSITY_TOO_LOW_ERROR, no longer raised by the service.
- Remove the retry-on-timeout note.
- Rephrase the page in more formal wording.
- OpenAPI: from the service's spec at master (3.1.0), plus 401/403.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@shimoncohen
shimoncohen dismissed stale reviews from syncush and asafmas-rnd via 8333610 October 14, 2026 13:24
@shimoncohen

Copy link
Copy Markdown
Contributor Author

Done: removed the retry note, documented that response order matches request order (true since dem-heights 3.1.0), and rephrased the page. Also synced to 3.1.0, which drops POINTS_DENSITY_TOO_LOW_ERROR.

@shimoncohen
shimoncohen merged commit 1292de4 into master Oct 14, 2026
2 checks passed
@shimoncohen
shimoncohen deleted the docs/elevation-errors branch October 14, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants