Mobility API v2: Retrieval of closed data

[Piiit]

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 Add this chapter... see https://github.com/noi-techpark/documentation/blob/master/FLIGHTRULES.md#i-want-to-retrieve-closed-data-in-v2 for details

[stefanodavid]

@Piiit Please be more specific:

1. you mean that I want to retrieve closed data in V2 is a chapter or do I need to pull everything under I want to change visibility of mobility data?

2. In paragraphI want to retrieve closed data in V2 there a link to https://github.com/noi-techpark/documentation/blob/master/FLIGHTRULES.md#i-want-to-get-an-access-token-from-our-oauth-20-keycloak-server: what should I add from there?

3. I have no idea how to access keycloak.

4. There is already a section called authentication in the documentation: https://opendatahub.readthedocs.io/en/latest/authentication.html#authentication

about the last point:

5. Do we support two different mechanism of authentication?
6. What's the relation between the two?
7. Should the two be put in the same section?

[Piiit]

@Piiit Please be more specific:

1. you mean that  _I want to retrieve closed data in V2_ is a chapter or do I need to pull everything under _I want to change visibility of mobility data_?

2. In paragraph_I want to retrieve closed data in V2_ there a link to _https://github.com/noi-techpark/documentation/blob/master/FLIGHTRULES.md#i-want-to-get-an-access-token-from-our-oauth-20-keycloak-server_: what should I add from there?

I suggest to combine these two chapters into one. Where you could use point 2 first and then point 1... The part with "To find your client_id go to keycloak/noi/clients...." can be omitted, since it is just for us internally.

3. I have no idea how to access keycloak.

The point 2 above describes it already a little bit, for developers that want our closed data, that should be enough. Do you have other questions about that?

4. There is already a section called _authentication_ in the documentation: https://opendatahub.readthedocs.io/en/latest/authentication.html#authentication

The tutorial https://opendatahub.readthedocs.io/en/latest/howto/authentication.html#authentication-howto is deprecated, since it is just for V1, V2 works only with keycloak alone.

about the last point:

5. Do we support two different mechanism of authentication?
6. What's the relation between the two?

It depends what you mean with that. We support only OAuth2.0 with keycloak within the new API (V2). However, within that, we support two grant types: password and refresh_token. See point 2... The first call must always be a "password" type, whereas all subsequent calls should be for security reasons "refresh_token" calls.

7. Should the two be put in the same section?

So the old tutorial is for V1 and the new one should talk about OAuth2 with keycloak and the two grant types. The general documentation in https://opendatahub.readthedocs.io/en/latest/authentication.html is still valid I guess, but I have just skimmed it...

[stefanodavid]

No feedback received from my clarification request email, so closing the issue.

[Piiit]

Hi, @stefanodavid ... Did I forgot some email? Sorry about that...

Let us talk next week and finish the API v2 documentation together during a dedicated day. I made some breaking changes to the V2, which I will deploy Monday or Tuesday next week, so we need definitively update the existing documentation as well.

See https://tomcatsec.testingmachine.eu/v2/ for details

To be honest, I've lost track a bit due to the many projects I manage.... so a dedicated day, just to finish all documentation regarding v2 would be nice: Pair programming :-)

What do you think?

ps. what do we do with this issue? Reopen or do you want to create new ones?

[Piiit]

@stefanodavid Superseded by #125... so this issue can definitively stay closed.