295b2fefb1
Squashed commit of the following:
commit 16e43b10edc8218f3d1ccec711d965c654dd851d
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Fri Mar 28 12:32:58 2025 +0300
all: upd chlog
commit 2a8dcab14e9cf43fe941f67f215efe2801f2aa65
Merge: 95a4ea8cc 8b4768aad
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Fri Mar 28 12:32:05 2025 +0300
Merge branch 'master' into ADG-9744-node-20
commit 95a4ea8ccbcc8cb5911b6c33007e36a04b03e616
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Mon Mar 24 14:06:25 2025 +0300
bamboo-specs: fix test
commit c535028cd16bf2100b45828fe7f7693b938aaeb5
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Mon Mar 24 14:02:47 2025 +0300
all: imp npm cache
commit bfc9d11153446b865b9756f35753e791d4040595
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Fri Mar 21 19:06:37 2025 +0300
all: fix specs
commit 7127498d6aa0e0ca4585d79a15ed5f3c5e643e3a
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Fri Mar 21 18:50:57 2025 +0300
all: upd node; rm outdated openapi lint
22 lines
800 B
Markdown
22 lines
800 B
Markdown
# AdGuard Home OpenAPI
|
||
|
||
We are using [OpenAPI specification](https://swagger.io/docs/specification/about/) to generate AdGuard Home API specification.
|
||
|
||
## How to edit the API spec
|
||
|
||
The easiest way would be to use [Swagger Editor](http://editor.swagger.io/) and just copy/paste the YAML file there.
|
||
|
||
## Changelog
|
||
|
||
[Here](CHANGELOG.md) 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:
|
||
|
||
```http
|
||
Authorization: Basic BASE64_DATA
|
||
```
|
||
|
||
Where `BASE64_DATA` is base64-encoded data for `username:password` string.
|