Skip to content
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.

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

feat: add new endpoints for api #22

Merged
merged 17 commits into from
Mar 27, 2024
Merged

feat: add new endpoints for api #22

merged 17 commits into from
Mar 27, 2024

Conversation

fabio-nettis
Copy link
Member

@fabio-nettis fabio-nettis commented Mar 27, 2024

Description

Exciting changes await! We added some very important new endpoints in this PR that still were missing. Here is what is now available:

Statistics

Statistics for the entire galaxy or a specific planet, this includes number of kills, friendly fire kills etc. Please Note that not every planet has statistics, this is because there may not have been fought a battle on it yet.

  • /api/statistics: List all available statistics.
  • /api/statistics/:id: Get a specific statistic by id.
  • /api/statistics/galaxy: Get the galaxy wide statistics.
  • /api/planets/:id/statistics: Get statistics for a planet.

Reports

You can find reports by pressing R2 or the PC equivalent while in your ship. Contain bits of story and lore based on the players actions and performance in the war.

  • /api/reports: List all available reports.
  • /api/reports/:id: Get a specific report by id.

Assignments

Assignments are Major Orders that are very important to the war progress. It is possible that a given time there is no Major Order and the endpoint will return an empty array.

  • /api/assignments: List all available assignments.
  • /api/assignments/:id: Get a specific assignment by id.
  • /api/assignments/:id/rewards: Get the rewards for a specific assignment.

Shout out to all developers over at Helldivers 2 Community that have reverse engineered the required endpoints for this addition to our API.

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Added test new files for all endpoints

  • added __tests__/statistics.test.ts
  • added __tests__/reports.test.ts
  • added __tests__/assignments.test.ts
  • added test inside __tests__/planets.test.ts

Test Configuration

  • Bun version: 1.0.35

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@fabio-nettis fabio-nettis added the feature Optimizes or introduces a feature label Mar 27, 2024
@fabio-nettis fabio-nettis merged commit b38e547 into main Mar 27, 2024
4 checks passed
@fabio-nettis fabio-nettis deleted the feat/new-endpoints branch March 27, 2024 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Optimizes or introduces a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant