a/badguardhome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
0d67aa251d
badguardhome/openapi
History
Ainar Garipov bba74859e2 Pull request: openapi: fix incorrect parameter name 
Merge in DNS/adguard-home from fix-openapi to master

Squashed commit of the following:

commit a448b80a57851d44634c00f0fd986f58b35dae80
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Jan 12 17:27:32 2021 +0300

    openapi: fix incorrect parameter name
2021-01-12 17:45:19 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md Pull request: all: improve dnsrewrite handling 2020-12-28 18:41:50 +03:00
index.html *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
openapi.yaml Pull request: openapi: fix incorrect parameter name 2021-01-12 17:45:19 +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.