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

Provide configuration endpoint that describes the existing/implemented data structure of the producer #663

Open
2 tasks
matt-wirtz opened this issue Jul 16, 2024 · 1 comment
Labels

Comments

@matt-wirtz
Copy link

What is the issue and why is it an issue?

As a consumer who is not familiar with the shared service the many "conditionally required" and "optional" structures (and endpoints) make an implementation more difficult: e.g. vehicles[].current_range_meters is required if the corresponding vehicle_type definition for this vehicle has a motor. But if there are no vehicle_types provided - which should be in the case if powered vehicles are provided but which is not a must - then it's tedious to find out.

Please describe some potential solutions you have considered (even if they aren’t related to GBFS).

It would be good to have some kind of "configuration" endpoint which describes the provider / service explicitly and thus enables an API consumer to rely on existence of structures / endpoints instead of having to check multiple combinations of "is it there or is it missing?

Is your potential solution a breaking change?

  • Yes
  • [ X ] No
  • Unsure
@mobilitydataio
Copy link
Contributor

This discussion has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.

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

No branches or pull requests

2 participants