@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api API title
@base https://www.refugerestrooms.org/api
@version 0.0.1
@endpoints 4
@toc restrooms(4)

@endpoint GET /v1/restrooms/by_date
@desc Search for restroom records updated or created on or after a given date
@required {day: any # Day, month: any # Month, year: any # Year}
@optional {page: any # Page offset to fetch., per_page: any # Number of results to return per page., offset: any # Pad a number of results., ada: any # Only return restrooms that are ADA accessible., unisex: any # Only return restrooms that are unisex., updated: any # Return restroom records updated (rather than created) since given date}
@returns(200) Search for restroom records updated or created on or after a given date

@endpoint GET /v1/restrooms/by_location
@desc Search by location.
@required {lat: any # latitude, lng: any # longitude}
@optional {page: any # Page offset to fetch., per_page: any # Number of results to return per page., offset: any # Pad a number of results., ada: any # Only return restrooms that are ADA accessible., unisex: any # Only return restrooms that are unisex.}
@returns(200) Search by location.

@endpoint GET /v1/restrooms/search
@desc Perform full-text search of restroom records.
@required {query: any # Your search query.}
@optional {page: any # Page offset to fetch., per_page: any # Number of results to return per page., offset: any # Pad a number of results., ada: any # Only return restrooms that are ADA accessible., unisex: any # Only return restrooms that are unisex.}
@returns(200) Perform full-text search of restroom records.

@endpoint GET /v1/restrooms
@desc Get all restroom records ordered by date descending.
@optional {page: any # Page offset to fetch., per_page: any # Number of results to return per page., offset: any # Pad a number of results., ada: any # Only return restrooms that are ADA accessible., unisex: any # Only return restrooms that are unisex.}
@returns(200) Get all restroom records ordered by date descending.

@end