Skip to content

Commit

Permalink
[:GHPAGES:] doc update
Browse files Browse the repository at this point in the history
Signed-off-by: Navid Yaghoobi <[email protected]>
  • Loading branch information
navidys committed Nov 9, 2023
1 parent b299c21 commit 6387449
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/goapi_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,31 @@ func :ref:`GetArrivalsByAirport <FUNC_GET_ARRIVALS_BY_AIRPORT>`

:Returns: :ref:`[]FlightData<TYPE_FLIGHT_DATA>`, error



.. _FUNC_GET_DEPARTURES_BY_AIRPORT:

func :ref:`GetDeparturesByAirport <FUNC_GET_DEPARTURES_BY_AIRPORT>`
----------------------------------------------------------------

Retrieves flights for a certain airport which departed within a given time interval [being, end].

The given time interval must not be larger than seven days!

.. code-block:: go
func GetDeparturesByAirport(ctx context.Context, airport string, begin int64, end int64) ([]FlightData, error)
:Parameters:
- **ctx** (`context.Context <https://pkg.go.dev/context#Context>`_) - connection context.
- **airport** (string) - ICAO identifier for the airport.
- **begin** (int64) - Start of time interval to retrieve flights for as Unix time (seconds since epoch).
- **end** (int64) - End of time interval to retrieve flights for as Unix time (seconds since epoch).

:Returns: :ref:`[]FlightData<TYPE_FLIGHT_DATA>`, error


.. _BBOX_FUNC:

func :ref:`NewBoundingBox <BBOX_FUNC>`
Expand Down

0 comments on commit 6387449

Please sign in to comment.