search

open-education-api / specification

OpenAPI (fka Swagger) specification for the Open Education API.
Other
32 stars 26 forks source link

Change/various fixes #220

Closed jelmerderonde closed 2 years ago

jelmerderonde commented 2 years ago

Een nieuwe PR met wederom een aantal wijzigingen:

  1. Fixt van een aantal typo's her en der.
  2. Ik heb wat gesleuteld aan het consumers attribuut en bijbehorend object en de examples gelijk goed gezet overal. De structuur is nu als volgt: 
    {
"...": "...",
"consumers": [
    {
        "consumerKey": "<the consumer key>"
        "additional": "custom",
        "attributes": "here"
    }
]
}

    Ik vond dit logischer dan de dubbel geneste structuur die we hiervoor hadden, maar hoor het graag als de meningen anders liggen.

  3. NT niveaus toegevoegd aan level enumeration.
  4. Aangepast hoe de redoc documentatie rendert, op basis van dit voorbeeld. Overigens biedt redoc nog meer interessante features, waar we misschien later nog wat mee willen.

Volgende week weer verder, nog genoeg te doen 😄

jelmerderonde commented 2 years ago

@hamrt ik kreeg de reference van de consumerexample maar niet werkend, dus uiteindelijk maar gecopy paste. Volgens mij kunnen we deze nu wel mergen, mogelijk later nog wat netter maken.