Skusim spisat moju definiciu OpenAPI skombinovanu s odpovedami tu + aj s constrainami, ktore si myslim ze by mali byt definovane. Bolo by super ak by sme do pondelka vecera dospeli k nejakemu ucelenemu textu so vsetkymi potrebnymi nalezitostami. Nasledne to viem hodit aj na Confluence pracovnej skupiny PS1 aby si to aj ostatni clenovia mohli pozriet.
OpenAPI
-
reprezentuje elektronickej služby verejnej správy prístupné verejnosti
-
elektronické služby sú určené ako na čítanie, no zároveň môžu byť použité aj na editáciu/tvorbu údajov
-
použitie služby je podmienené prihlásením
-
služba musí byť zaregistrovaná v Metainformačnom systéme, kde sa nachádza
- minimálne štruktúrovaná API dokumentácia :
- v pripade REST služby je štruktúrovane zdokumentovaná prostredníctvom OpenAPI 3.0
- v prípade SOAP služby je štruktúrovane zdokumentovaná prostredníctvom WSDL + XSD
- popis metadát služby na úrovni metadát je v súlade s CSPV-AP štandardom EU (kto je gestorom, endpoint, odkedy služba je zaregistrovaná)
- minimálne štruktúrovaná API dokumentácia :
-
ak dátový prvok používaný na rozhraní služby má mapovanie na prvok v Centrálnom modely údajov, tak je tento vzťah zapísaný štruktúrovane v dokumentácii
-
prístup môže byť riadený prostredníctvom technického komponentu API Gateway
-
ak existujú referenčné URI identifikátory pre entity v službách, je vyžadované ich použitie