search

noi-techpark / odh-docs

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

Mobility API v2 getting started, general feedback #117

Closed Piiit closed 4 years ago

Piiit commented 4 years ago

Does your feedback relate to a specific page? If yes, please add the link here. https://opendatahub.readthedocs.io/en/latest/howto/mobility/getstarted.html

Your feedback

What I mean with these points is that we have 3 levels here: 1) get stationtypes (that is just metadata) 2) get stationtypes -> stations (that is also just metadata) 3) a) get stationtypes -> stations -> datatypes -> measurements (most recent one) b) get stationtypes -> stations -> datatypes -> measurement (of a timespan)

The important concept here is that metadata is always considered open data, so level 1) and 2) always return data, whereas level 3) might not return data.

stefanodavid commented 4 years ago

Hi @Piiit, is this related to PR #111? If so, why was it merged without review? I think it would have been far far clearer to keep this feedback within that PR before merging it. Otherwise, what's the purpose of PRs, if they don't get reviewed?

stefanodavid commented 4 years ago

@Piiit what is the difference between this issue and #116?

Piiit commented 4 years ago

@stefanodavid No, the PR was fine, just overlooked the shownull thing. What these things here are proposals for enhancements as you also see in the labels. A bug would stop the merge, thou... these enhancements could also be done later, when you have time. So, to not stop you from continuing your work, I merged it...

Piiit commented 4 years ago

@Piiit what is the difference between this issue and #116?

No, this is the description of the semantics, the hierarchy within our data. The schema is the reponse body parts, that describe a generic station, generic station type, measurement etc. It is like a schema in Postgres which contains information about constraints for instance. For example, sname is a string and has a constraint not null, etc. smetadata can be any JSON or null....

stefanodavid commented 4 years ago

@Piiit can you provide a full description of the schema? Together with the information I asked you last week by email, I should be able to write once a complete description of the API response, instead of having 2-3 issues for that.

Piiit commented 4 years ago

@stefanodavid I will try to do it this week. Do you mean the "mvalue & state" email? Have I forgotten some other email?

stefanodavid commented 4 years ago

@Piiit yes I mean that one.

stefanodavid commented 4 years ago

Do you mean the "mvalue & state" email? Have I forgotten some other email?

@Piiit, I guess that I can close this issue and #116, because I added all the content of that email in commit 2d6b3db9 (see also PR #126). Comments in this issue's description should be superseded in this PR.