cotugno/AdGuardHome
2
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-15 18:08:30 -07:00
Code Issues Packages Projects Releases Wiki Activity
e83b919dbd
AdGuardHome/openapi
History
Ainar Garipov 7e08565212 Pull request: openapi: doc client id better 
Merge in DNS/adguard-home from doc-client-id to master

Squashed commit of the following:

commit ea03887d505296e5033964e8227ed906b102d990
Merge: 693453b5 841bb9bc
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Feb 11 15:20:56 2021 +0300

    Merge branch 'master' into doc-client-id

commit 693453b5eab40e201501d6881418ee42191a1bc5
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Feb 11 12:55:01 2021 +0300

    openapi: doc client id better
2021-02-11 15:41:03 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md Pull request: openapi: doc client id better 2021-02-11 15:41:03 +03:00
index.html *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
openapi.yaml Pull request: openapi: fix naming in filter object 2021-02-01 16:01:33 +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.