Comcast / Comcast/RestfulHttpsProxy

[Documentation] API documentation should extended

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Go
Stars
14
Forks
3
PR merge metrics
No merged PRs in 30d

Description

## Problem
It may be hard for a new user to start using this project, since the documentation api documentation does not specify what happens if fields are left out.

## Feature Description
* Add more examples to `api-example-rewrites.md` so it is different from the readme and more detailed.
* Improve documentation about what happens if a key is left out of api requests, such as `clientIP`
* Other things that may be potentially confusing to new users.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.