search

noi-techpark / odh-docs

Open Data Hub (http://opendatahub.com/) Documentation
http://opendatahub.readthedocs.io/en/latest/index.html
3 stars 4 forks source link

Mobility: available vs active #164

Closed Piiit closed 3 years ago

Piiit commented 3 years ago

Does your feedback relate to a specific page? If yes, please add the link here.

Ex. http://opendatahub.readthedocs.io/en/latest/intro.html You can leave this blank, if it is a general feedback.

Important for all mobility sections, that describe the response containing available fields. For example, savailable or pavailable etc.

Your feedback Since the new version 1.0.0 (released on 2020-09-28) we no longer expose stations which have either available = false or availaibe = NULL, that is we expose only available = true stations.

However, in order to not break the API we still expose all ...available fields (in SELECT) and allow savailable constraint (in WHERE). This should have been an internal only field, never exposed to the outside world, but it has been exposed in the past and now we cannot hide it anymore, some applications might break.

I suggest to update the available vs active description with somethink similar to:

We expose only **available** stations, but for historical reasons the
`savailable` fields are still accessible. Availability should have been an
internal-only field to mark a station visible through the API.......

Any questions? Please let me know... :-)

Piiit commented 3 years ago

@stefanodavid FYI

stefanodavid commented 3 years ago

@Piiit I understand the big picture, but some details are not clear. I will try to come to your office next week to clarify them.

Piiit commented 3 years ago

@stefanodavid That is OK for me. Which details are not clear? Maybe we could resolve them with some comments here?

stefanodavid commented 3 years ago

@Piiit here my doubts:

1.

Does your feedback relate to a specific page? If yes, please add the link here.

Ex. http://opendatahub.readthedocs.io/en/latest/intro.html

Are you sure that this is the right section where to put the information? The fields of the JSON response are described in https://opendatahub.readthedocs.io/en/latest/howto/mobility/getstarted.html#apiv2-keys-1

  1. I suggest to update the available vs active description with somethink similar to:

    We expose only **available** stations, but for historical reasons the
`savailable` fields are still accessible. Availability should have been an
internal-only field to mark a station visible through the API.......

    What has "active" to do with the description? This would be a change concerning only availability AFAIU.

Piiit commented 3 years ago

@stefanodavid

https://opendatahub.readthedocs.io/en/latest/howto/mobility/getstarted.html#apiv2-keys-1

Right place, do not know if there are other places?

What has "active" to do with the description? This would be a change concerning only availability AFAIU.

Yes, you are right... only availability

stefanodavid commented 3 years ago

Hi @Piiit

@stefanodavid

https://opendatahub.readthedocs.io/en/latest/howto/mobility/getstarted.html#apiv2-keys-1

Right place, do not know if there are other places?

I think that the improvements required in this issue have already been covered in #163, in particular in the notes in the definitions of Edge and Nodes, can you please check? The only improvement I can think of is to put these notes in a more prominent place.

Piiit commented 3 years ago

@stefanodavid I consider it as solved, thanks!