search

open-education-api / specification

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

Minimize required fields #315

Open jelmerderonde opened 3 weeks ago

jelmerderonde commented 3 weeks ago

OOAPI is being used for various different applications. Every application has its own set of requirements (consumer). Currently, for each entity, we specify a set of required attributes.

Proposal: only make the entity ID required, all other top-level fields optional. Requirements for specific applications can be specified in consumers.

jelmerderonde commented 3 weeks ago

See also:

The error message says ‘Initials is not specified’. OAAPI demands for students to have a first name. However, this student doesn’t have a first name (as many Asian students). Therefore, a “.” is registered as first name: I think most universities deal with such students in this way.

https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/