Skip to content
This repository has been archived by the owner on Oct 18, 2024. It is now read-only.

Releases: icssc/peterportal-api-next

v1.0.0-rc.3

04 Sep 04:38
Compare
Choose a tag to compare

What's Changed

[BREAKING CHANGE] Normalized Section Meeting/Final Exam Times GA

When querying the WebSoc endpoint, section meeting and final exam times will be returned as structured data, in the following format:

"meetings": [
  {
    "timeIsTBA": false,
    "bldg": ["ON LINE"],
    "days": "WF",
    "startTime": { "hour": 10, "minute": 0 },
    "endTime": { "hour": 10, "minute": 50 }
  },
  {
    "timeIsTBA": false,
    "bldg": ["ALP 1300"],
    "days": "M",
    "startTime": { "hour": 10, "minute": 0 },
    "endTime": { "hour": 10, "minute": 50 }
  }
],
"finalExam": {
  "examStatus": "SCHEDULED_FINAL",
  "dayOfWeek": "Sat",
  "month": 5,
  "day": 10,
  "startTime": { "hour": 13, "minute": 30 },
  "endTime": { "hour": 15, "minute": 30 },
  "bldg": ["HIB 100"]
},

For more examples of the new meetings and finalExam fields, check out the documentation here.

Please do note that this is a breaking change. If you require assistance migrating from v1.0.0-rc.2 and previous versions, please don't hesitate to reach out on our Discord in the #api-help channel.

Full Changelog: v1.0.0-rc.2...v1.0.0-rc.3

v1.0.0-rc.2

15 Aug 17:00
Compare
Choose a tag to compare

What's Changed

Courses/Instructors Filtering GA

Filtering is now generally available for querying courses and instructors; no longer are you constrained to fetching them individually by course number/UCInetID.

For instance, you can get all courses under the COMPSCI department with the following query:

curl "https://api-next.peterportal.org/v1/rest/courses?department=COMPSCI"

Or, equivalently, in GraphQL:

query {
  courses(department: "COMPSCI") {
    id
  }
}

As for filtering instructors, you can get all faculty affiliated with the Computer Science department like so:

curl "https://api-next.peterportal.org/v1/rest/instructors?departmentContains=Computer%20Science"

Or, equivalently, in GraphQL:

query {
  instructors(departmentContains: "Computer Science") {
    ucinetid
  }
}

For more examples, check out the documentation here.

Full Changelog: v1.0.0-rc.1...v1.0.0-rc.2

v1.0.0-rc.1

27 Jul 15:58
Compare
Choose a tag to compare

This is the first preview release of PeterPortal API-Next. (We do not speak of v1.0.0-rc.0.) It has feature parity with the legacy PeterPortal API, and then some.

Do note that this is a breaking change, so migrating from PeterPortal API may be an involved process. We encourage all developers to read the docs first, but if you have any additional questions, please don't hesitate to reach out through our Discord.

Full Changelog: https://github.com/icssc/peterportal-api-next/commits/v1.0.0-rc.1