open-education-api / specification

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

[Change request]: Make possible to link component to multiple courses #305

Open pgh70 opened 12 months ago

pgh70 commented 12 months ago

Organization

Fringe company

Project

Onderwijs Catalogus

Contact Details

Patrick.Honing@fringe.nl

Short description

Please add the possibility to link a component to multiple courses. A generic component should be available to be used by multiple courses.

Version

v5

Usecase

We, at Fringe Company, want to make the entities of our Onderwijs Catalogus (OC) available to our customers using the OOAPI spec. Our entity "Leeractiviteit" maps on the OOAPI "component" object. In our OC the entity "Leeractiviteit" can be linked to multiple "Opleidingsonderdelen" (which maps to the OOAPI "course" object). In order to properly expose the relationships to the objects for our customers, we need to be able to return multiple relationships via the API. On this moment we can only use the "ext" object to expose this relationship.

Which institutions support this change?

No response

Proposed solution

Change the type of course to array of strings or array of Course

Requests and responses

GET /components/{componentId}

What is your question for the OOAPI work group?

No response