search

erasmus-without-paper / ewp-specs-api-discovery

Specifications of EWP's Discovery API.
MIT License
3 stars 1 forks source link

Adding information about host provider to the manifest #19

Closed mkurzydlowski closed 2 years ago

mkurzydlowski commented 2 years ago

During the Infrastructure Forum on 2022-03-02, it has been suggested to add information about the host provider to the manifest:

https://owncloud.erasmuswithoutpaper.eu/index.php/s/zyNXSfU78NMtULf?path=%2F2022-03-02_Infrastructure_Forum

Slide 21 contains the following bullet:

Add information about provider to the first line of admin-notes: <ewp:admin-notes>Provider: MUCI (USOS)</ewp:admin-notes> <ewp:admin-notes>Provider: Gent University (OASIS)</ewp:admin-notes> <ewp:admin-notes>Provider: Masaryk University (ISOIS)</ewp:admin-notes>

This recommendation has been well received by many partners and already implemented by some of them.

After that meeting another proposal has been made to move the provider name to a separate field in the manifest.

mkurzydlowski commented 2 years ago

This topic has also been discussed in those GitHub issues: https://github.com/erasmus-without-paper/general-issues/issues/35#issuecomment-1073072243 https://github.com/erasmus-without-paper/ewp-specs-api-registry/issues/7#issuecomment-1073275467

mkurzydlowski commented 2 years ago

It should be noted that adding a new element to the EWP catalogue is backward-compatible as only the EWP registry implements the Registry API (see bullet two of the backward-compatibility rules).

That way, we don't need to force all of the EWP clients to change.

janinamincer-daszkiewicz commented 2 years ago

Just for reference, here it has been suggested to use a separate field: https://github.com/erasmus-without-paper/ewp-specs-api-registry/issues/7#issuecomment-1081572458

It should be noted that adding a new element to the EWP catalogue is backward-compatible as only the EWP registry implements the Registry API (see bullet two of the backward-compatibility rules). That way, we don't need to force all of the EWP clients to change.

Please, share your opinion

georgschermann commented 2 years ago

we added it in in the admin notes for now

janinamincer-daszkiewicz commented 2 years ago

Yes, some of the providers answered to my 'good practices' advice :) However if we are to make the field mandatory, the separate field seems to be more appropriate.

mkurzydlowski commented 2 years ago

It has been voted to add a separate field for the provider name.

janinamincer-daszkiewicz commented 2 years ago

Done (Compare ewp-specs-api-discovery stable-v5 with stable-v6).