docs(openapi): add spec for arrivals-and-departures-for-location endpoint#807
Open
3rabiii wants to merge 2 commits intoOneBusAway:mainfrom
Open
docs(openapi): add spec for arrivals-and-departures-for-location endpoint#8073rabiii wants to merge 2 commits intoOneBusAway:mainfrom
3rabiii wants to merge 2 commits intoOneBusAway:mainfrom
Conversation
Contributor
Author
|
Marking this as a draft for now. |
Contributor
Contributor
Author
|
Ok, I originally linked it to the base openapi.yml PR, but no problem! I just edited it to link to your PR that creates this endpoint. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the missing OpenAPI specification for the
arrivals-and-departures-for-locationendpoint.While reviewing the legacy Java documentation and codebase (
ArrivalsAndDeparturesForLocationAction) for API parity, I noticed this endpoint was missing from theopenapi.ymlspec. This PR ensures the spec accurately reflects the legacy behavior and the upcoming Go implementation.Changes Made
/api/where/arrivals-and-departures-for-location.jsonpath.latSpan,lonSpan,time,routeType, andemptyReturnsNotFound).ArrivalsDeparturesForLocationResponseschema in thecomponents/schemassection to accurately reflect the nested response structure (usingentrywithstopIds,arrivalsAndDepartures, andnearbyStopIds).Related Issues/PRs
#787
@aaronbrethorst