Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pagination of Free Bikes? #112

Closed
black-tea opened this issue Oct 18, 2018 · 11 comments
Closed

Pagination of Free Bikes? #112

black-tea opened this issue Oct 18, 2018 · 11 comments

Comments

@black-tea
Copy link

Hi-

I wanted to get some clarification on the NABSA standard for the GBFS free bikes feed. In the City of Los Angeles, we are requiring that dockless mobility companies provide information on the status of available devices, adhering as best as possible to the NABSA guidelines. However, we've seen some providers implementing pagination of results.

I'm not sure what the historical scale of docked bikeshare has been, so this question is thinking a bit about how GBFS has operated in the past, but also how it should be thought about for the future in adapting it for dockless companies.

  1. Does the omission of pagination on the output format section on the structure of the free_bikes feed mean that paginating results are not allowed?
  2. It is reasonable to forbid paginating results, given the proliferation of dockless devices, and thus the high result count of any GET request?

We've been having this discussion within our own MDS here.

Thank you!

@fruminator
Copy link
Contributor

fruminator commented Oct 18, 2018 via email

@hunterowens
Copy link

hunterowens commented Oct 18, 2018

For Metro Bikeshare, a 93 Station system, I simulated what a 10K bike system would be.

In [25]: len(data['data']['stations']) Out[25]: 93

`
2.4M Oct 18 15:52 mbs_10k_sample.json

21K Oct 18 15:53 station_status.json
`

at 10K stations, GBFS feed would be 2.4 MB.

@fruminator
Copy link
Contributor

fruminator commented Oct 18, 2018 via email

@heidiguenin
Copy link
Contributor

Hey all! Now that we're actually moving toward a versioning scheme and then likely making use of it right away with #147, I'd like to suggest we bundle up a few other small breaking changes, including this one.

It seems like there's general consensus here that the clarification is worth making. @black-tea, want to open the PR?

@fruminator
Copy link
Contributor

fruminator commented Nov 1, 2019 via email

@heidiguenin
Copy link
Contributor

It sounded to me like the general agreement was that we should revise GBFS to clarify that pagination of results is not allowed.

@fruminator
Copy link
Contributor

fruminator commented Nov 1, 2019 via email

@barbeau
Copy link
Member

barbeau commented Nov 1, 2019

I would say that given the current GBFS Output Format docs, it's strongly implied that pagination already isn't supported. So if we add text to the spec to say that pagination is not allowed, I would call this a clarification and not a breaking change.

@heidiguenin
Copy link
Contributor

@barbeau Agreed. I don't think we need to alter the spec, but it does answer the question hat @black-tea asked. Pagination isn't supported, so isn't allowed according to spec.

(cc @hunterowens )

I will close this issue in a few days.

@barbeau
Copy link
Member

barbeau commented Nov 12, 2019

@heidiguenin I would suggest that we add a sentence to the spec explicitly saying that pagination isn't supported to avoid questions like this again in the future.

@heidiguenin
Copy link
Contributor

@barbeau sounds good. We're working on editing the spec for consistency and other small editorial changes, and we'll wrap this into it.

@christrillium

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants