mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2025-02-20 11:44:09 +08:00

History

Ainar Garipov 5292c7c387 Pull request: openapi: upd version

Closes #3364.

Squashed commit of the following:

commit 840c20c87ccd64a83010718c68d65adcb390134d
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Jul 20 12:24:06 2021 +0300

    openapi: upd version

2021-07-20 12:31:52 +03:00

.gitignore

Added swagger UI scripts

2018-12-28 18:26:14 +03:00

CHANGELOG.md

Pull request: 2145 optimistic cache

2021-07-14 21:03:56 +03:00

index.html

*(documentation): removed unnecessary dependencies

2020-05-21 00:04:41 +03:00

openapi.yaml

Pull request: openapi: upd version

2021-07-20 12:31:52 +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

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