Documentation about API authorization and POST parameters is out-dated
- Dominant language
- C#
- Stars
- 5.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
The readme states that the a combination of [ApiKey]:[ApiSecret] is used for authorization at the endpoint. This is not correct as the file "Server/Auth/ApiAuthorizationFilter.cs" expects an authorization string that uses a Base64 encoded version of [ApiKey]:[ApiSecret]
Also some parameters of POST requests changed from a capital first letter to a lowercase first letter.
**To Reproduce**
Steps to reproduce the behavior:
Perform a GET request on "/api/Devices" with authorization header and receive an 403 status.
Perform a POST request as described in the readme, which will fail.
**Remotely Version**
Serve: latest
**Expected Behavior**
Readme communicates the correct way to authorize and also the POST parameters are correct
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the README instructions for authorization and POST requests, then compare them with Server/Auth/ApiAuthorizationFilter.cs and the documented /api/Devices request. Update the README to describe the Base64-encoded authorization value and the current lowercase POST parameters; verify the examples match the expected GET and POST behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api, authentication, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100