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

Learning Agreements
MIT License
1 stars 2 forks source link

Inconsistencies in get-response.xsd's latest-changes and latest-proposal #10

Closed j-be closed 3 years ago

j-be commented 3 years ago

After looking at https://github.com/erasmus-without-paper/ewp-specs-api-omobility-las/blob/master/endpoints/get-response.xsd for quite some time I noticed ~two~ three inconsistencies.

The first one seems to be a typo in <xs:element name="latest-changes" ...'s xs:documentation:

The second one ist the definition of <xs:element name="latest-proposal"

EDIT: The third one is the documentation of the unnamed element containing before-mobility and latest-approved:

The "before mobility" and "latest approved" sections are optional - this indicates that no LA has yet been approved. However, if "before mobility" section exists, then we also require "latest approved" section to exist.`

contradicts with both of them being minOccurs="1" maxOccurs="1". I would propose to change the documentation to:

The "before mobility" and "latest approved" sections are optional - this indicates that no LA has yet been approved. However, if either of the two sections exists, then we also require the other section to exist."

kamil-olszewski-uw commented 3 years ago

Your comments relate to the "master" branch, which reflects the LAs of the old Erasmus + program.

The latest version of the API, still unofficial and almost ready (we are working on the final touches), can be found in the "new-la-template" branch, which will soon be transformed into a new official API version:

https://github.com/erasmus-without-paper/ewp-specs-api-omobility-las/blob/new-la-template/endpoints/get-response.xsd

Changing the branch in GitHub is possible using the button in the upper left corner.

The things you describe no longer apply to this new branch.

However, responding to your comments:

(1) You are right about the "last-approved" typo. (2) Indeed, the items you have listed are mandatory (minOccurs = "1"). But please note that those items are inside optional sequences.

j-be commented 3 years ago

Oh, that is unfortunate. From @janinamincer-daszkiewicz comments on #9 I somehow deduced, that master is "kind of stable". I must have misinterpreted.

There are still open points in #9 though, so should you have some spare time I would appreciate any new insight. :smiley: