Missing course requirements

[Samuel-Martineau]

It seems like all courses currently have no requirementsDescription.

curl -X 'GET' \
  'https://openapi.data.uwaterloo.ca/v3/Courses/1255/math/138' \
  -H 'accept: application/json'

[
  {
    "courseId": "006881",
    "courseOfferNumber": 1,
    "termCode": "1255",
    "termName": "Spring 2025",
    "associatedAcademicCareer": "UG",
    "associatedAcademicGroupCode": "MAT",
    "associatedAcademicOrgCode": "MATHDEAN",
    "subjectCode": "MATH",
    "catalogNumber": "138",
    "title": "Calculus 2 for Honours Mathematics",
    "descriptionAbbreviated": "Calculus 2 (Honours)",
    "description": "Introduction to the Riemann integral and approximations. Antiderivatives and the fundamental theorem of calculus. Change of variables, methods of integration. Applications of the integral. Improper integrals. Linear and separable differential equations and applications. Tests for convergence for series. Binomial series, functions defined as power series and Taylor series. Vector (parametric) curves in R2. Suitable topics are illustrated using computer software.",
    "gradingBasis": "NUM",
    "courseComponentCode": "LEC",
    "enrollConsentCode": "N",
    "enrollConsentDescription": "No Consent Required",
    "dropConsentCode": "N",
    "dropConsentDescription": "No Consent Required",
    "requirementsDescription": null
  }
]

It also seems like the API contract is being violated. Whereas the API contract specifies that an object should be returned, the endpoint returns an array of objects.

[sbobkin]

The array response vs the spec is likely a bug. There are cases where course Ids are not unique in a term and so we return arrays. The subject and catalog number version in a term should be unique though. I'm going to verify this again, and have to check if we've had this mismatch of return from the start or introduced it later. That will help to determine if I change the response, ie: breaking change, or update the expectation.

On the requirements description I posted a longer response in the other issue that's on the same topic, #232 (comment)

[sbobkin]

I made a minor update that makes the expected schema match the actual result. While the subject and catalog number combination in a term should be unique, this is less disruptive to any implemented clients.