Web API

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
api, security

Research direction

Start by reviewing the existing Checks Module API Controller and the issue's completed API-controller checklist item. Determine the intended rate limits and authentication requirements for remote gamedig queries, then verify that both protections are implemented and that the API no longer exposes unrestricted port-scanning capability.

Written by the indexing model from the issue text.

Description

enhancement

I can see some benefits from making some of the features available as a web API.
Remote gamedig queries for example.

  • Checks Module API Controller
  • Implement rate limits
  • Add authentication to the API

Limits need to be imposed as it's effectively a port scanner.

Dominant language
C#
Stars
3
Forks
2
Avg merge
15h 46m
Merged PRs (30d)
1

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GameServerManagers/LinuxGSM-Support-Bot

All issues in GameServerManagers/LinuxGSM-Support-Bot

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.