Skip to content

Commit

Permalink
v2.0.0 Breaking Changes, Added Fac de Droit et Science Politique, Mod…
Browse files Browse the repository at this point in the history
…ified sort, Fixed doc

Added:
- Fac de Droit et Science Politique

Modified:
- Can now sort also in desc

Fixed:
- Doc not referencing sort parameter

Breaking changes:
Changing repo name and url, changing API url concordantly
  • Loading branch information
TheGeeKing committed Mar 19, 2024
1 parent 1ed0c11 commit 8b64a8f
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 7 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# FdS-UMontpellier-ICal-API
# UMontpellier-ICal-API

## Description

This repository has for goal to provide an API to get the ICal of the courses of the FdS of the University of Montpellier. For now, it only provides ICals for the Fac des Sciences 2023-2024 (open for pull requests to add other faculties).
This repository has for goal to provide an API to get the ICal of the courses of the University of Montpellier. For now, it only provides ICals for the Fac des Sciences and Fac de Droit et Science Politique 2023-2024 (open for pull requests to add other faculties).

You can either get JSON data or directly the ICal file. In JSON, you get a "raw" key to access the raw ICal event read by the API. The ICal version served does not contain some data due to the fact that ADE generates new unusefull `UID`, `SEQUENCE`, `LAST-MODIFIED` and `CREATED` each time.

Expand All @@ -22,6 +22,7 @@ Routes are:
- `description` ➜ Get the courses with this description
- `descriptionMatchType` ➜ The type of match for the description ([`""`(use SQL, LIKE %description%), `strict`, `regex`]; default: `""`)
- `raw` ➜ Get the raw ICal of the courses ([`""`(include it), `only`(size ~-28.5%), `exclude`(size ~-70%)]; default: `""`)
- `sort` ➜ Get the courses sorted by start date ([`""` (not sorted), `asc`, `desc`]; default: `""`)
- `format` ➜ The format of the response ([`json`, `ical`, `ics`]; default: `json`)
- `/id/:id` ➜ Get the course with the given id
- `format` ➜ The format of the response ([`json`, `ical`, `ics`]; default: `json`)
Expand All @@ -35,4 +36,4 @@ Examples of usage: \

## Hosted version

You can use the latest version at [https://fds-ical-api.home.mma.dev/](https://fds-ical-api.home.mma.dev/). ⚠️ Uptime is not guaranteed. Generally down between 00:00-08:15 UTC+1.
You can use the latest version at [https://um-ical-api.home.mma.dev/](https://um-ical-api.home.mma.dev/). ⚠️ Uptime is not guaranteed. Generally down between 00:00-08:15 UTC+1.
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: '3'

services:
api:
container_name: fds-ical-api
container_name: um-ical-api
build: .
restart: unless-stopped
ports:
Expand Down
Loading

0 comments on commit 8b64a8f

Please sign in to comment.