Skip to content

Add sort param to comments doc #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2025
Merged

Add sort param to comments doc #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/v1/get-comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ A call to this endpoint returns comments of a specified kind: game, achievement,

### Query Parameters

| Name | Required? | Description |
| :--- | :-------- | :------------------------------------------------------------------------------------------------------ |
| `y` | Yes | Your web API key. |
| `i` | Yes | The target game or achievement ID (if type is 1 or 2). The target username or user ULID (if type is 3). |
| `t` | Sometimes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). Required if type is 1 or 2. |
| `c` | | Count, number of records to return (default: 100, max: 500). |
| `o` | | Offset, number of entries to skip (default: 0). |
| Name | Required? | Description |
| :----- | :-------- | :------------------------------------------------------------------------------------------------------ |
| `y` | Yes | Your web API key. |
| `i` | Yes | The target game or achievement ID (if type is 1 or 2). The target username or user ULID (if type is 3). |
| `t` | Sometimes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). Required if type is 1 or 2. |
| `c` | | Count, number of records to return (default: 100, max: 500). |
| `o` | | Offset, number of entries to skip (default: 0). |
| `sort` | | Sort order, sort comments. 'submitted' = ascending, '-submitted' = descending (default: 'submitted') |

## Client Library

Expand Down