Skip to content

Commit

Permalink
Update contract for Get Comments endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
@ioslife
ioslife committed Sep 12, 2024
1 parent 82167f0 commit cc2cca1
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/v1/get-comments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ A call to this endpoint returns comments of a specified kind: game, achievement,

### Query Parameters

| Name | Required? | Description |
| :--- | :-------- | :--------------------------------------------------------------- |
| `y` | Yes | Your web API key. |
| `t` | Yes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). |
| `i` | | The target game or achievement ID (if type is 1 or 2). |
| `u` | | The target username (if type is 3). |
| `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. |
| `t` | Yes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). |
| `i` | Sometimes | The target game or achievement ID (if type is 1 or 2). The target username (if type is 3). 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). |

## Client Library

Expand Down

0 comments on commit cc2cca1

Please sign in to comment.