search

erasmus-without-paper / ewp-specs-api-omobility-las

Learning Agreements
MIT License
1 stars 2 forks source link

ola dashboard scenarios #20

Closed saouling closed 3 years ago

saouling commented 3 years ago

We added a PDF (EDDSI_OLA_Dashboard_use_cases_and_scenarios.pdf) in which the flow of 8 basic use case scenarios is described, referencing the corresponding XML files.

kamil-olszewski-uw commented 3 years ago

Well done with this document, it looks very nice and informative! :-)

I only have a small problem with messages like "#the version id of the LA should not change". Together, we concluded that id versions of the LAs would only be applicable if a version history API was created. For the rest of users, the version ids mean nothing and can be confusing. What do you think?

kkaraogl commented 3 years ago

Not sure where the confusion is. We've already seen these scenarios together a couple of times. Should we remove these lines in order for this to get merged?

There are partners ready to start implementing and testing the exchange of LAs with us, and we'd like to share these guidelines with them.

tsiakmaki commented 3 years ago

Such clarification should remain. In most cases, the idea of versioning is to update a version_id of an object whenever a change happen to it. At the scenarios, we point the cases where this should not happen.

Also, this will also help towards the version history API.

kamil-olszewski-uw commented 3 years ago

My concern is that we don't use the term "version id" anywhere in the IIAs API. Implementers may think that there is a version id somewhere in the API, or that these guidelines are out of date. In time, when they ask us about it, we may no longer remember what it is about. I think it would be enough to change "version id" to "version".

But it's not that critical, so we will merge this commit. However, I leave this comment for future reference, in case it turns out that this id is confusing.