open-education-api / specification

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

update arrays in responses #217

Closed hamrt closed 2 years ago

hamrt commented 2 years ago

At the moment alle arrays are labeled as items and not as mutliples of the objects they represent. An example: the resultset of GET persons this result contains items these items are person objects therfor the array should be persons? items is to ambiguous

hamrt commented 2 years ago

items will continue to be used as this is programatically an easier option. Bezides the objects in the array are defined by the collection type that is requested the items in the personsCollection will only be persons. The items in an associationsCollection only associations