a/badguardhome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dbe8b92dfc
badguardhome/openapi
History
Ainar Garipov dbe8b92dfc Pull request: all: make stats disableable, imp code 
Updates #2141.

Squashed commit of the following:

commit d8f3bcd9927b00a1d4b8b60b43144bc4b4469311
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Jun 17 19:10:53 2021 +0300

    stats: imp docs, names

commit 97eae3c2da5585467ca024bdacdbf922bcc8b444
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Jun 17 18:51:49 2021 +0300

    all: make stats disableable, imp code
2021-06-17 19:44:46 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md Pull request: all: make stats disableable, imp code 2021-06-17 19:44:46 +03:00
index.html *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
openapi.yaml Pull request: all: make stats disableable, imp code 2021-06-17 19:44:46 +03:00
package.json *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
README.md Pull request: * home, openapi: improve docs and responses 2020-11-05 13:59:57 +03:00
yarn.lock *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00

README.md

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

  1. yarn install
  2. yarn start
  3. 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.