Skip to content

Update API docs to match OpenAPI spec: latitude/longitude only#195

Merged
bkeepers merged 2 commits into
copilot-worktree-2026-01-20T12-42-16from
copilot/sub-pr-192-again
Jan 27, 2026
Merged

Update API docs to match OpenAPI spec: latitude/longitude only#195
bkeepers merged 2 commits into
copilot-worktree-2026-01-20T12-42-16from
copilot/sub-pr-192-again

Conversation

Copy link
Copy Markdown

Copilot AI commented Jan 27, 2026

The API documentation claimed the HTTP endpoints accept coordinate aliases (lat, lon, lng), but the OpenAPI spec only defines latitude and longitude as valid parameters. Requests using aliases are rejected by the validator before reaching handlers.

Changes:

  • Removed all references to coordinate aliases from API README
  • Updated curl examples to use latitude and longitude

Note: The main neaps library (not the HTTP API) continues to support aliases via GeolibInputCoordinates. Only the HTTP API endpoints are restricted to the full parameter names.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: bkeepers <173+bkeepers@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to align with OpenAPI spec for latitude and longitude Update API docs to match OpenAPI spec: latitude/longitude only Jan 27, 2026
Copilot AI requested a review from bkeepers January 27, 2026 21:56
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (527ef53) to head (948c9d2).
⚠️ Report is 6 commits behind head on copilot-worktree-2026-01-20T12-42-16.

Additional details and impacted files
@@                          Coverage Diff                           @@
##           copilot-worktree-2026-01-20T12-42-16      #195   +/-   ##
======================================================================
  Coverage                                100.00%   100.00%           
======================================================================
  Files                                        67        67           
  Lines                                       595       595           
  Branches                                     77        77           
======================================================================
  Hits                                        595       595           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bkeepers bkeepers marked this pull request as ready for review January 27, 2026 22:23
@bkeepers bkeepers merged commit 5e60401 into copilot-worktree-2026-01-20T12-42-16 Jan 27, 2026
6 checks passed
@bkeepers bkeepers deleted the copilot/sub-pr-192-again branch January 27, 2026 22:23
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.

2 participants