open-education-api / specification

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

[Change request]: Some fields contain the wrong language #291

Closed Tomeriko96 closed 9 months ago

Tomeriko96 commented 1 year ago

Organization

Vrije Universiteit Amsterdam

Project

No response

Contact Details

No response

Short description

Some fields contains values written in the wrong language, e.g. some fields with EN: translation have a dutch entry; and some NL: vertaling fields contain values written in english.

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 10 months ago

@Tomeriko96 do you have some examples? Do you mean actual attributes in the objects or is the error in descriptions and examples?

Tomeriko96 commented 9 months ago

@jelmerderonde

The issue was on values not matching the language tag is was associated with. See the example below. I had expected that there would be two different values, one in Dutch and one in English.

I also provide the code in R to reproduce it.

Note: this is just a single example.

api_response <- httr::GET("https://demo05.test.surfeduhub.nl/education-specifications?pageSize=100")

jsonResponseText <- httr::content(api_response, as = "text", encoding = "UTF-8")

df <- jsonlite::fromJSON(jsonResponseText, flatten = TRUE) %>% 
  as.data.frame(check.names = FALSE) 

head(df$items.learningOutcomes, 1)
[[1]]
[[1]][[1]]
  language                                                                              value
1    en-GB EN TRANSLATION: nieuwe inzichten over het opdoen van kennis in een complexe wereld
2    nl-NL   NL VERTALING: nieuwe inzichten over het opdoen van kennis in een complexe wereld

[[1]][[2]]
  language                                                                 value
1    en-GB EN TRANSLATION: inzicht in de bijzondere eigenschappen van materialen
2    nl-NL   NL VERTALING: inzicht in de bijzondere eigenschappen van materialen
jelmerderonde commented 9 months ago

Hi @Tomeriko96 , you're looking at data from our "demo data" endpoints, which do not represent real Educational Institutions. These endpoints are not meant to have 100% realistic information. They mainly serve as an example and it would be too much work to make them 100% correct.

You can expect a "real endpoint" from an actual institution to have more realistic data where the languages match.

Since this is not an issue with the specification I'm closing this issue.