mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AdGuardHome/openapi
History
Ainar Garipov 8fb76701f4 Pull request 1974: 6133-upd-quic-go 
Updates #6133.

Squashed commit of the following:

commit cb096e3cdef8e85fa3a27e3bb3065317aaa29048
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Wed Aug 23 19:41:04 2023 +0300

    openapi: imp chlog

commit 623594f95d4be3a03e451849f7b1b5181785aeeb
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Wed Aug 23 19:25:47 2023 +0300

    all: upd quic-go, txt-lint
 		2023-08-23 20:10:54 +03:00
..
CHANGELOG.md Pull request 1974: 6133-upd-quic-go 2023-08-23 20:10:54 +03:00
README.md Pull request: * home, openapi: improve docs and responses 2020-11-05 13:59:57 +03:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
openapi.yaml Pull request 1928: 1453-stats-tests 2023-08-09 14:33:52 +03:00
package.json *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
v1.yaml Pull request: websvc-config-manager 2022-10-04 16:02:55 +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.