pi-hole / FTL

The Pi-hole FTL engine
https://pi-hole.net
Other
1.34k stars 187 forks source link

Improve API /clients documentation #1944

Closed DL6ER closed 1 month ago

DL6ER commented 2 months ago

What does this implement/fix?

Documentation-only change for API /clients: Add note that {client} needs to be URI-encoded (if specified) and add documentation of read-only optional {name} field.

Related issue or feature (if applicable): Fixes https://github.com/pi-hole/FTL/issues/1943

Pull request in docs with documentation (if applicable): N/A


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)

Checklist: