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

GBFS v3 and API paths #456

Closed
testower opened this issue May 15, 2024 · 2 comments · Fixed by #486
Closed

GBFS v3 and API paths #456

testower opened this issue May 15, 2024 · 2 comments · Fixed by #486
Assignees
Labels
enhancement New feature or request

Comments

@testower
Copy link
Collaborator

GBFS v3 feeds are now available at /gbfs/v3beta/...

Considering v3 is strictly speaking no longer in beta, there's the question what the path should now be, and should we change other paths.

The situation is complicated further because our api gateway also has versioning for proxies:

https://api.entur.io/mobility/v2/gbfs/v3beta/voistavanger/gbfs

where /mobility/v2 simply points to the lamassu instance.

Overview of current paths

GBFS v2

  • /gbfs - system discovery
  • /gbfs/{systemid}/{feed}(.json) - system feeds

GBFS v2 internal (deprecated 🙏 see also #263)

  • /gbfs-internal - system discovery
  • /gbfs-internal/{systemid}/{feed}(.json) - system feeds

GBFS v3

  • /gbfs/v3beta/manifest.json - system discovery
  • /gbfs/v3beta/{systemid}/{feed}(.json) - system feeds

GraphQL

  • /graphql - GraphQL endpoint
  • /graphiql - GraphiQL UI if enabled

Validation

  • /validation/* - validation (report) endpoints

Health

  • /health/* - health probe endpoints

Admin endpoints

  • /admin/* (not going into details on this)
@testower
Copy link
Collaborator Author

Let's discuss at the next meeting @hbruch

@testower testower changed the title API paths GBFS v3 and API paths May 15, 2024
@testower testower added the enhancement New feature or request label May 15, 2024
@testower
Copy link
Collaborator Author

Deprecate /gbfs
Add /gbfs/v2/ and /gbfs/v3 paths

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

Successfully merging a pull request may close this issue.

2 participants