Skip to content

Commit

Permalink
refactor: mirror RAWeb's project structure for easier maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
wescopeland committed Feb 25, 2024
1 parent 42d6b37 commit 452d80b
Show file tree
Hide file tree
Showing 37 changed files with 171 additions and 133 deletions.
66 changes: 33 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,55 +27,55 @@ Click the function names to open their complete docs on the docs site.

### User

- [Profile](https://api-docs.retroachievements.org/v1/users/profile.html) - Get a user's basic profile information.
- [Unlocks (most recent)](https://api-docs.retroachievements.org/v1/users/recent-achievements.html) - Get a list of achievements recently earned by the user.
- [Unlocks (by date range)](https://api-docs.retroachievements.org/v1/users/achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
- [Unlocks (on date)](https://api-docs.retroachievements.org/v1/users/achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
- [Game Progress](https://api-docs.retroachievements.org/v1/users/game-progress.html) - Get metadata about a game as well as a user's progress on that game.
- [All Completion Progress](https://api-docs.retroachievements.org/v1/users/completion-progress.html) - Get metadata about all the user's played games and any awards associated with them.
- [Awards / Badges](https://api-docs.retroachievements.org/v1/users/user-awards.html) - Get a list of a user's site awards/badges.
- [Set Development Claims](https://api-docs.retroachievements.org/v1/users/claims.html) - Get a list of set development claims made over the lifetime of a user.
- [Game Rank and Score](https://api-docs.retroachievements.org/v1/users/game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
- [Point Totals](https://api-docs.retroachievements.org/v1/users/points.html) - Get a user's total hardcore and softcore points.
- [Specific Games Progress](https://api-docs.retroachievements.org/v1/users/specific-games-progress.html) - Get a user's progress on a list of specified games.
- [Recently Played Games](https://api-docs.retroachievements.org/v1/users/recently-played-games.html) - Get a list of games a user has recently played.
- [Summary](https://api-docs.retroachievements.org/v1/users/get-user-summary.html) - Get a user's profile metadata.
- [Completed Games](https://api-docs.retroachievements.org/v1/users/completed-games.html) - Legacy endpoint. Get hardcore and softcore completion metadata about games a user has played.
- [Profile](https://api-docs.retroachievements.org/v1/get-user-profile.html) - Get a user's basic profile information.
- [Unlocks (most recent)](https://api-docs.retroachievements.org/v1/get-user-recent-achievements.html) - Get a list of achievements recently earned by the user.
- [Unlocks (by date range)](https://api-docs.retroachievements.org/v1/get-achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
- [Unlocks (on date)](https://api-docs.retroachievements.org/v1/get-achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
- [Game Progress](https://api-docs.retroachievements.org/v1/get-game-info-and-user-progress.html) - Get metadata about a game as well as a user's progress on that game.
- [All Completion Progress](https://api-docs.retroachievements.org/v1/get-user-progress.html) - Get metadata about all the user's played games and any awards associated with them.
- [Awards / Badges](https://api-docs.retroachievements.org/v1/get-user-awards.html) - Get a list of a user's site awards/badges.
- [Set Development Claims](https://api-docs.retroachievements.org/v1/get-user-claims.html) - Get a list of set development claims made over the lifetime of a user.
- [Game Rank and Score](https://api-docs.retroachievements.org/v1/get-user-game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
- [Point Totals](https://api-docs.retroachievements.org/v1/get-user-points.html) - Get a user's total hardcore and softcore points.
- [Specific Games Progress](https://api-docs.retroachievements.org/v1/get-user-progress.html) - Get a user's progress on a list of specified games.
- [Recently Played Games](https://api-docs.retroachievements.org/v1/get-user-recently-played-games.html) - Get a list of games a user has recently played.
- [Summary](https://api-docs.retroachievements.org/v1/get-user-summary.html) - Get a user's profile metadata.
- [Completed Games](https://api-docs.retroachievements.org/v1/get-user-completed-games.html) - Legacy endpoint. Get hardcore and softcore completion metadata about games a user has played.

### Game

- [Summary](https://api-docs.retroachievements.org/v1/games/summary.html) - Get basic metadata about a game.
- [Extended Details](https://api-docs.retroachievements.org/v1/games/detailed-info.html) - Get extended metadata about a game.
- [Achievement IDs](https://api-docs.retroachievements.org/v1/games/achievement-ids.html) - Get the list of achievement IDs for a game.
- [Unlocks Distribution](https://api-docs.retroachievements.org/v1/games/achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
- [High Scores](https://api-docs.retroachievements.org/v1/games/high-scores.html) - Get a list of either the latest masters or highest hardcore points earners for a game.
- [Summary](https://api-docs.retroachievements.org/v1/get-game.html) - Get basic metadata about a game.
- [Extended Details](https://api-docs.retroachievements.org/v1/get-game-extended.html) - Get extended metadata about a game.
- [Achievement IDs](https://api-docs.retroachievements.org/v1/get-achievement-count.html) - Get the list of achievement IDs for a game.
- [Unlocks Distribution](https://api-docs.retroachievements.org/v1/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
- [High Scores](https://api-docs.retroachievements.org/v1/get-game-rank-and-score.html) - Get a list of either the latest masters or highest hardcore points earners for a game.

### Achievement
### System

- [All Unlocks](https://api-docs.retroachievements.org/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement, targeted by achievement ID.
- [Get All Systems](https://api-docs.retroachievements.org/v1/get-console-ids.html) - Get the complete list of system ID and name pairs on the site.
- [Get All Games and Hashes](https://api-docs.retroachievements.org/v1/get-game-list.html) - Get the complete list of games for a console, including their hashes.

### System
### Achievement

- [Get All Systems](https://api-docs.retroachievements.org/v1/consoles/all-systems.html) - Get the complete list of system ID and name pairs on the site.
- [Get All Games and Hashes](https://api-docs.retroachievements.org/v1/consoles/all-games.html) - Get the complete list of games for a console, including their hashes.
- [All Unlocks](https://api-docs.retroachievements.org/v1/get-achievement-unlocks.html) - Get a list of users who have earned an achievement, targeted by achievement ID.

### Feed

- [Active Claims](https://api-docs.retroachievements.org/v1/feed/get-active-claims.html) - Retrieve active achievement set development claims.
- [Inactive Claims](https://api-docs.retroachievements.org/v1/feed/get-claims.html) - Retrieve achievement set development claims that have been completed, dropped, or are expired.
- [Top Ten Ranked Users](https://api-docs.retroachievements.org/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.
- [Active Claims](https://api-docs.retroachievements.org/v1/get-active-claims.html) - Retrieve active achievement set development claims.
- [Inactive Claims](https://api-docs.retroachievements.org/v1/get-claims.html) - Retrieve achievement set development claims that have been completed, dropped, or are expired.
- [Top Ten Ranked Users](https://api-docs.retroachievements.org/v1/get-top-ten-users.html) - Get the list of top ten points earners.

### Event

- [Achievement of the Week](https://api-docs.retroachievements.org/v1/events/achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
- [Achievement of the Week](https://api-docs.retroachievements.org/v1/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.

### Ticket

- [Get Ticket by ID](https://api-docs.retroachievements.org/v1/tickets/get-ticket-by-id.html)
- [Get Most Ticketed Games](https://api-docs.retroachievements.org/v1/tickets/get-most-ticketed-games.html)
- [Get Most Recent Tickets](https://api-docs.retroachievements.org/v1/tickets/get-most-recent-tickets.html)
- [Get Game Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-game-ticket-stats.html)
- [Get Developer Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-developer-ticket-stats.html)
- [Get Ticket by ID](https://api-docs.retroachievements.org/v1/get-ticket-data/get-ticket-by-id.html)
- [Get Most Ticketed Games](https://api-docs.retroachievements.org/v1/get-ticket-data/get-most-ticketed-games.html)
- [Get Most Recent Tickets](https://api-docs.retroachievements.org/v1/get-ticket-data/get-most-recent-tickets.html)
- [Get Game Ticket Stats](https://api-docs.retroachievements.org/v1/get-ticket-data/get-game-ticket-stats.html)
- [Get Developer Ticket Stats](https://api-docs.retroachievements.org/v1/get-ticket-data/get-developer-ticket-stats.html)

## How to Contribute

Expand Down
64 changes: 32 additions & 32 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -52,59 +52,59 @@ export default defineConfig({
items: [
{
text: "Profile",
link: "/v1/users/profile",
link: "/v1/get-user-profile",
},
{
text: "Unlocks (most recent)",
link: "/v1/users/recent-achievements",
link: "/v1/get-user-recent-achievements",
},
{
text: "Unlocks (by date range)",
link: "/v1/users/achievements-earned-between",
link: "/v1/get-achievements-earned-between",
},
{
text: "Unlocks (on date)",
link: "/v1/users/achievements-earned-on-day",
link: "/v1/get-achievements-earned-on-day",
},
{
text: "Game Progress",
link: "/v1/users/game-progress",
link: "/v1/get-game-info-and-user-progress",
},
{
text: "All Completion Progress",
link: "/v1/users/completion-progress",
link: "/v1/get-user-progress",
},
{
text: "Awards / Badges",
link: "/v1/users/user-awards",
link: "/v1/get-user-awards",
},
{
text: "Set Development Claims",
link: "/v1/users/claims",
link: "/v1/get-user-claims",
},
{
text: "Game Rank and Score",
link: "/v1/users/game-rank-and-score",
link: "/v1/get-user-game-rank-and-score",
},
{
text: "Point Totals",
link: "/v1/users/points",
link: "/v1/get-user-points",
},
{
text: "Specific Games Progress",
link: "/v1/users/specific-games-progress",
link: "/v1/get-user-progress",
},
{
text: "Recently Played Games",
link: "/v1/users/recently-played-games",
link: "/v1/get-user-recently-played-games",
},
{
text: "Summary",
link: "/v1/users/get-user-summary",
link: "/v1/get-user-summary",
},
{
text: "Completed Games",
link: "/v1/users/completed-games",
link: "/v1/get-user-completed-games",
},
],
},
Expand All @@ -114,23 +114,23 @@ export default defineConfig({
items: [
{
text: "Summary",
link: "/v1/games/summary",
link: "/v1/get-game",
},
{
text: "Extended Details",
link: "/v1/games/detailed-info",
link: "/v1/get-game-extended",
},
{
text: "Achievement IDs",
link: "/v1/games/achievement-ids",
link: "/v1/get-achievement-count",
},
{
text: "Unlocks Distribution",
link: "/v1/games/achievement-distribution",
link: "/v1/get-achievement-distribution",
},
{
text: "High Scores",
link: "/v1/games/high-scores",
link: "/v1/get-game-rank-and-score",
},
],
},
Expand All @@ -140,11 +140,11 @@ export default defineConfig({
items: [
{
text: "All Systems",
link: "/v1/consoles/all-systems",
link: "/v1/get-console-ids",
},
{
text: "All Games and Hashes",
link: "/v1/consoles/all-games",
link: "/v1/get-game-list",
},
],
},
Expand All @@ -154,7 +154,7 @@ export default defineConfig({
items: [
{
text: "All Unlocks",
link: "/v1/achievements/get-achievement-unlocks",
link: "/v1/get-achievement-unlocks",
},
],
},
Expand All @@ -164,15 +164,15 @@ export default defineConfig({
items: [
{
text: "Active Claims",
link: "/v1/feed/get-active-claims",
link: "/v1/get-active-claims",
},
{
text: "Inactive Claims",
link: "/v1/feed/get-claims",
link: "/v1/get-claims",
},
{
text: "Top Ten Ranked Users",
link: "/v1/feed/get-top-ten-users",
link: "/v1/get-top-ten-users",
},
],
},
Expand All @@ -181,7 +181,7 @@ export default defineConfig({
items: [
{
text: "Achievement of the Week",
link: "/v1/events/achievement-of-the-week",
link: "/v1/get-achievement-of-the-week",
},
],
},
Expand All @@ -191,27 +191,27 @@ export default defineConfig({
items: [
{
text: "Get Ticket by ID",
link: "/v1/tickets/get-ticket-by-id",
link: "/v1/get-ticket-data/get-ticket-by-id",
},
{
text: "Get Most Ticketed Games",
link: "/v1/tickets/get-most-ticketed-games",
link: "/v1/get-ticket-data/get-most-ticketed-games",
},
{
text: "Get Most Recent Tickets",
link: "/v1/tickets/get-most-recent-tickets",
link: "/v1/get-ticket-data/get-most-recent-tickets",
},
{
text: "Get Game Ticket Stats",
link: "/v1/tickets/get-game-ticket-stats",
link: "/v1/get-ticket-data/get-game-ticket-stats",
},
{
text: "Get Developer Ticket Stats",
link: "/v1/tickets/get-developer-ticket-stats",
link: "/v1/get-ticket-data/get-developer-ticket-stats",
},
{
text: "Get Achievement Ticket Stats",
link: "/v1/tickets/get-achievement-ticket-stats",
link: "/v1/get-ticket-data/get-achievement-ticket-stats",
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion docs/connect/standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ For now, you can follow this process:
1. Ask the user what their RA username is.
2. Once they provide their username, ask them to insert some GUID/key that you generate into their account motto [on this page](https://retroachievements.org/controlpanel.php). If the user is logged in, this URL will always link to the place they can update their motto.
3. Ask the user to confirm that the key is inserted into their motto.
4. Once the user gives confirmation, verify that the motto has been updated with the Web API's [user profile endpoint](/v1/users/profile).
4. Once the user gives confirmation, verify that the motto has been updated with the Web API's [user profile endpoint](/v1/get-user-profile).

Mottos have a maximum length of 50 characters. Once you've confirmed the user motto, it's probably worth reminding the user to reset the motto.

Expand Down
Empty file removed docs/v1/data-models/auth-object.md
Empty file.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Game Achievement IDs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Game Unlocks Distribution
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Achievement of the Week
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Achievement Unlocks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# User Unlocks (by date range)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# User Unlocks (on date)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Active Claims
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/feed/get-claims.md → docs/v1/get-claims.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Inactive Claims
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Get All Systems
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Game Extended Details
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# User Game Progress
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/consoles/all-games.md → docs/v1/get-game-list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# All System Games and Hashes

A call to this endpoint will retrieve the complete list of games for a specified console on the site, targeted by the console ID. If you do not know the console ID you're looking for, try using the [all systems](/v1/consoles/all-systems) endpoint.
A call to this endpoint will retrieve the complete list of games for a specified console on the site, targeted by the console ID. If you do not know the console ID you're looking for, try using the [all systems](/v1/get-console-ids) endpoint.

::: danger
**Consider aggressively caching this endpoint's response.** The response size for some system IDs can be huge. The data doesn't change very often. Frequent calls to this endpoint may prompt us to look into your bandwidth usage. [Refer to our usage guidelines](/#api-access) for more details.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# High Scores
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/games/summary.md → docs/v1/get-game.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import SampleRequest from '../../components/SampleRequest.vue';
import SampleRequest from '../components/SampleRequest.vue';
</script>

# Game Summary
Expand Down
Loading

0 comments on commit 452d80b

Please sign in to comment.