Kanoninen sopimus
OpenAPI 3.1 -dokumentti on reittien, metodien, pakollisten kenttien, enumien, rajojen, sisältötyyppien ja virhevastausten totuuslähde. Käsin kirjoitetut oppaat selittävät turvallisen käytön korvaamatta sopimusta.
Operaatioryhmät
| Ryhmä | Operaatiot |
|---|---|
| Datasetit | Listaa datasetit, hae dataset, health |
| Releaset | Listaa releaset, hae release, lataa release |
| Kyselyt | Kysy julkaistuja rivejä |
| Buildit | Listaa, luo, hae ja peru buildit |
| Synteesi | Luo määrittelyt, aja reseptit, tarkista raportit ja listaa portin läpäisseet releaset |
Yhteinen pyyntösopimus
| Otsake | Vaatimus |
|---|---|
| Authorization | Bearer API -avain; pakollinen |
| X-API-Version | Valinnainen; oletus 1 |
| Content-Type | application/json POST-rungoille |
| Accept | application/json rakenteisille vastauksille |
Yhteensopivuuspolitiikka
v1:een voidaan lisätä valinnaisia vastauskenttiä. Rikkovat reitti-, metodi-, pakollinen kenttä- tai semantiikkamuutokset vaativat uuden API-pääversion ja migraatio-ohjeen. Dataset-builderin release-skeema validoidaan erikseen julkisen adapterin takana.