search

open-education-api / specification

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

[Change request]: specify how sorting and other parameters should work with language typed strings #268

Open jelmerderonde opened 2 years ago

jelmerderonde commented 2 years ago

Organization

SURF

Project

No response

Contact Details

No response

Short description

Since OOAPI v5 a lot of attributes are specified as "language typed strings", allowing the implementation to provide information to the client in multiple languages at the same time.

However, it is not clearly specified which language should be used when the client also sets query parameters such as sort or q.

Version

v5

Usecase

No response

Which institutions support this change?

No response

Proposed solution

No response

Requests and responses

No response

What is your question for the OOAPI work group?

No response

jelmerderonde commented 2 years ago

One option could be to also have a language query parameter that the client can use to specify in which language to search / sort