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

API: IBNR key naming inconsistent across models #2418

Open
marhei opened this issue Mar 11, 2024 · 3 comments
Open

API: IBNR key naming inconsistent across models #2418

marhei opened this issue Mar 11, 2024 · 3 comments
Labels
APIv1 bug Something isn't working

Comments

@marhei
Copy link
Contributor

marhei commented Mar 11, 2024

Unlike all other models, the IBNR in the 'stopover' model is not marked as 'IBNR' but as 'evaIdentifier'.

@marhei marhei added the bug Something isn't working label Mar 11, 2024
@marhei marhei changed the title IBNR key naming inconsistent across API models API: IBNR key naming inconsistent across models Mar 11, 2024
@MrKrisKrisu
Copy link
Member

MrKrisKrisu commented Mar 11, 2024

Which name would you prefer?

In the context of #2411, the model of the stations could be modified anyway so that an array with external IDs is added there. This would also make migration easier for API consumers.

{
  "station": {
      "id": 6882,
      "name": "Karlsruhe-Durlach",
      "coordinates": {
          "latitude": 49.002025,
          "longitude": 8.462292,
      }
      "identifier": {
          "eva": 8003184,
          "ril100": "RKDU",
          "ifopt": "de:08212:801"
      }
  },
}

@marhei
Copy link
Contributor Author

marhei commented Mar 11, 2024

I think that's the right way to handle it.

@HerrLevin
Copy link
Member

HerrLevin commented Mar 25, 2024

We should include a prefix for the keys eva and ril100, because the name itself is not necessarily unique. E.g. db:ibnr, oebb:ibnr and such. (Just for future proofing these IDs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIv1 bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants