Adapt our general API design to WP2 use cases

wrygiel commented 8 years ago

@StefanJahnke wrote:

the explanations for the Use-Cases aren't very elaborate yet but the most crucial information is on github.

Ok, thanks. I'll try to have a look at it tomorrow!

How do you envision the facilitation of work between WP2, WP3 and WP4 now? I guess we should include Geir in the conversation to move forward.

In general, we use GitHub issue tracker and try to be public with all conversations like this one, so I'm going to reply you here. @geirmv (and other watchers) should receive notification.

To answer your question, since:

WP2 is primarily responsible for use cases,
WP3 is primarily responsible for the model,
WP4 is primarily responsible for the API design and architecture.

So, I think this would be the most effective order:

First thing to do is to fix my "EWP Mobility Process Explained" document. This document describes the overall design of all the APIs and how the data flows (without getting into the detailed models). We will later build all APIs based on this document, so it should be consistent with your document on use cases. Fixing this document will be my job. While working on it, I will also build stub versions of all APIs.

Then, I guess, WP3s job will be to fill these stubs with a detailed model (i.e. adding and documenting new elements to the XML Schema files).

Of course, we can all help each other with each of these steps.

wrygiel commented 8 years ago

I started a complete rewrite of the EWP Mobility Process Explained document this Tuesday. I will be updating all the descriptions and all the flowcharts. Hopefully, I'll finish with a revamped API design proposal by the end of next week.

wrygiel commented 8 years ago

@StefanJahnke, I have just reviewed your report (revision 5cba3fc) and I'm happy to say that I'm 99% sure that all requirements will be met in the next revision of our design document :) I will be publishing a detailed side-by-side comparison next week.

wrygiel commented 8 years ago

Ok! I think I'm finished for now and I am ready for your reviews.

A new version of the EWP Mobility Process Explained document is ready for review (v0.2.0). Read it here.
Stub versions of all the APIs (with descriptions of input parameters) are also ready. The easiest way to access all these documents is via the http://developers.erasmuswithoutpaper.eu/ page.
I have also prepared a side-by-side(-ish) comparison of WP2's use cases and WP4's APIs. You can read it here: https://github.com/erasmus-without-paper/ewp-wp4-use-cases

I am closing this issue now. If any of you see any missing features in our API design, please submit each such problem in a separate issue (one issue per one class of problem) - most probably in the ewp-specs-mobility-flowcharts repository - here.

wrygiel commented 8 years ago

@erasmus-without-paper/wp3

erasmus-without-paper / ewp-specs-mobility-flowcharts

Adapt our general API design to WP2 use cases #5