Skip to content

Commit

Permalink
Update API v2 docs after improvements to API
Browse files Browse the repository at this point in the history
  • Loading branch information
Ninjaclasher authored and Xyene committed Dec 25, 2023
1 parent 15ce3a0 commit 430149b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/site/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Example: [/api/v2/contests?tag=seasonal&tag=dmopc](https://dmoj.ca/api/v2/contes

#### List filters

- `key` - contest key
- `tag` - tag name
- `organization` - organization id

Expand Down Expand Up @@ -221,6 +222,7 @@ Example: [/api/v2/problems?partial=True&type=Uncategorized](https://dmoj.ca/api/

#### List filters

- `code` - problem code
- `group` - problem group full name
- `type` - problem type full name
- `organization` - organization id
Expand Down Expand Up @@ -296,6 +298,8 @@ Example: [/api/v2/users?organization=8](https://dmoj.ca/api/v2/users?organizatio

#### List filters

- `id` - user id
- `username` - user username
- `organization` - organization id

#### Object response
Expand Down Expand Up @@ -357,6 +361,7 @@ Example: [/api/v2/submissions?user=Ninjaclasher](https://dmoj.ca/api/v2/submissi

#### List filters

- `id` - submission id
- `language` - language key
- `result` - string

Expand Down Expand Up @@ -442,6 +447,9 @@ Example: [/api/v2/organizations?is_open=False](https://dmoj.ca/api/v2/organizati

- `is_open` - boolean

#### List filters
- `id` - organization id

#### Object response

```json
Expand All @@ -462,6 +470,10 @@ Example: [/api/v2/languages?common_name=Python](https://dmoj.ca/api/v2/languages

- `common_name` - language common name

#### List filters
- `id` - language id
- `key` - language key

#### Object response

```json
Expand Down

0 comments on commit 430149b

Please sign in to comment.