AdguardTeam/AdGuardHome
1
1
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-12-16 03:45:45 +03:00
Code Issues Packages Projects Releases Wiki Activity
a409cdc2bb
AdGuardHome/openapi
History
Simon Zolin 4303b3dd2f + dns: new settings for cache 
Squashed commit of the following:

commit e5b488249a4d972efd63c6e96830d9f30829aee1
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Tue Jun 16 15:38:27 2020 +0300

    + dns: new settings for cache
2020-07-03 20:35:04 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md *(querylog): added offset/limit parameters 2020-05-26 15:37:37 +03:00
index.html *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
openapi.yaml + dns: new settings for cache 2020-07-03 20:35:04 +03:00
package.json *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
README.md *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +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.