mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-08-16 22:20:30 +03:00
Merge in DNS/adguard-home from 1577-rewrite-edit to master
Squashed commit of the following:
commit d03bee2a14337d169eea950b3df18a447c02b422
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Fri May 12 12:54:15 2023 +0300
filtering: imp tests
commit bd68320df6dc057d922d91551cd00c74ebfaad6c
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Fri May 12 10:38:12 2023 +0300
filtering: rewrite http tests
commit 0d8bbcd0194c0db89a6d4b45927669423c9bbb59
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 11 12:06:30 2023 +0300
filtering: rewrite http tests
commit 29080384dd8fa80d5286d2fac1a4429d712bbafa
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 10 17:24:00 2023 +0300
filtering: imp code
commit 96c6b1c98debfae565c5e6254746959a4307744e
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 10 16:56:32 2023 +0300
filtering: imp code
commit b5d0c50ea11f9d829ba9d2b188fcc471a965e012
Merge: 5fa9e1c37
|
||
---|---|---|
.. | ||
CHANGELOG.md | ||
index.html | ||
openapi.yaml | ||
package.json | ||
README.md | ||
v1.yaml | ||
yarn.lock |
AdGuard Home OpenAPI
We are using OpenAPI specification to generate AdGuard Home API specification.
How To Edit The API Spec
The easiest way would be to use Swagger Editor and just copy/paste the YAML file there.
How To Read The API Doc
yarn install
yarn start
- Open
http://localhost:4000/
Changelog
Here we keep track of all non-compatible changes that are being made.
Authentication
If AdGuard Home's web user is password-protected, a web client must use
authentication mechanism when sending requests to server. Basic access
authentication is the most simple method - a client must pass Authorization
HTTP header along with all requests:
Authorization: Basic BASE64_DATA
Where BASE64_DATA is base64-encoded data for username:password
string.