Skip to content

docs: add arrivals-and-departures-for-location endpoint#166

Open
3rabiii wants to merge 3 commits intoOneBusAway:mainfrom
3rabiii:add-location-endpoint-docs
Open

docs: add arrivals-and-departures-for-location endpoint#166
3rabiii wants to merge 3 commits intoOneBusAway:mainfrom
3rabiii:add-location-endpoint-docs

Conversation

@3rabiii
Copy link
Copy Markdown

@3rabiii 3rabiii commented Mar 29, 2026

Description

This PR adds the missing documentation for the arrivals-and-departures-for-location API endpoint.

Changes Included:

  • New Method Page: Created arrivals-and-departures-for-location.md containing a complete list of all supported query parameters (including latSpan, routeType, emptyReturnsNotFound, etc.).
  • Sample Response: Added a detailed JSON payload matching the legacy Java server output to clarify the nested entry and nearbyStopIds structure.
  • Navigation: Registered the endpoint in rest_api.json so it appears in the side navigation menu.
  • Element Link: Added a reference to this new endpoint in arrival-and-departure.md since it returns this element as part of its payload.

Local Preview (Screenshots)

Here is how the new endpoint and the updated elements page look like when running locally:
image

@aaronbrethorst
closes: #165

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.

Add documentation for arrivals-and-departures-for-location endpoint

1 participant