Suunnittelutyön sisällöllisenä pohjana on käytetty M0, M1- ja M2-skeemoja. Lisäksi yritän seurata https://iow.csc.fi/model/edu/Opintokokonaisuus/ ja elmo-skeemaa. Toteutuksessa huomioitavaksi https://docs.google.com/document/d/12zgmNg9JEQOJfdoQ3it3JoL9DCNWieDrXLuaEQ9YA3I/edit#heading=h.g4fj974c7ixf.
Ajankohtaista (25.9.2018)! Toukokuussa 2018 Aallon järjestämässä rajapintaseminaarissa tunnistettiin tarve tehdä skeemat kokonaan englanninkielisiksi. CSC teki kesän 2018 aikana käännöstyön, jonka jälkeen on tarve käydä skeemat läpi eri sidosryhmien näkökulmasta. Tässä vaiheessa voidaan vielä tehdä korjauksia ja muutoksia, ennen kuin korkeakoulujen ja opetushallituksen skeemoja hyödyntävät projektit lähtevät toteutusvaiheeseen.
Englanniksi käännetyt työversiot skeemoista ovat omalla alasivullaan Schemas in English. Kyseiselle sivulle kootaan skeemojen viimeistelyvaiheen käsittelyä tukeva ja työssä tuotettava materiaali. Esimerkiksi opintotarjontaskeemasta on tuotettu TaY:n läpikäynnin tuloksena ehdotus uudesta skeemaversiosta.
Valmisteluvaihe 2017-kevät 2018
Skeeman valmistelun välituloksia
Käytin https://github.com/highsource/jsonix-schema-compiler muuntaakseni M0 ja M1XML XSD skeeman javascriptiksi: M0.js ja mace_funet_fi_studydata.js ja org_purl_dc_elements__1.js . Tämä vaati catalog :n käyttöä tai käyttämättömien skeeman osien poistamista. M2XLM-skeemaan javatyökalut eivät ole toistaiseksi purreet: virheilmoituksia. Käytin samaa työkalua myös elmo-skeeman muuntamiseen: https_github_com_emrex_eu_elmo_schemas_tree_v1.js . Valitettavasti en oikein keksi miten hyödyntää näitä swagger skeeman tekemisessä.
Edellisessä työpajassa vaadittiin, että skeemaan tulee pystyä ilmaisemaan suoritustapojen rinnakkaisuutta (ja) tai vaihtoehtoisuutta (tai). Koska swagger 2 skeemassa ei voi toteuttaa tarjonnan suoritustapoihin tarvittua ja/tai-logiikkaa, käytän tarjontaskeemassa openapi 3.0 määritystä, jossa on ja/tai-logiikan mahdollistava anyOf-operaattori. https://app.swaggerhub.com/apis/CSC6/M2_api/1.0.0-oas3 OpenAPI 3 ei ole vielä tuettu työkalujen puolelta, esim: swaggerilla ei ole editoria vaan pitää käyttää tuota swaggerhubin, jonka toiminta on epämääräistä. Toisessa ikkunassa skeema on validi ja toisessa ei. Koulutusolio /curriculum/ ei ole vielä viimeistelty. Lisäksi M2-olio on nostettu päätasolle LOSin tai LOIn laajennuksesta ja vaihtoehtoisesti lokalisoitu.
Muut ovat edelleen swagger 2 skeema http://editor2.swagger.io/#!/ eikä sitä ole tarkoituskaan päivittää OpenAPI 3, jotta toimittajat pääsevät käyttämään työkaluja. Minkään skeeman APIa ei ole erityisesti suunniteltu.
Skeeman valmistelun lopputuloksia viimeistelyä varten
Kaikkiin allaoleviin on lisätty purkuaika-kenttä CSCRISTIINOPISKELU-184 - Getting issue details... STATUS .
Tarjontaskeemaan CSC6_M2_api_1.0.0-oas3_lyhyt.json CSC6_M2_api_1.0.0-oas3_lyhyt.yaml lisatty verkostokohtainen status tarjonnalle. Noudatan ewp-specs-api-courses.
verkostosopimus.yaml verkosto.json
opiskeluoikeus.json opiskeluoikeus01.yaml lisättu eppn ja lisätietoja.
opintosuoritus01.yaml opintosuoritus01.json lisätty okmohjauksenala.