cotugno/AdGuardHome
2
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-16 02:18:28 -07:00
Code Issues Packages Projects Releases Wiki Activity
2409282d51
AdGuardHome/openapi
History
Ainar Garipov 2409282d51 Pull request 1783: fix-openapi-chlog 
Merge in DNS/adguard-home from fix-openapi-chlog to master

Squashed commit of the following:

commit cc8a7526a230edffd0eb86a5a69c565c221996f1
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Mar 24 15:19:57 2023 +0300

    openapi: fix chlog
2023-03-24 15:25:16 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md Pull request 1783: fix-openapi-chlog 2023-03-24 15:25:16 +03:00
index.html *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
openapi.yaml Pull request: 1333-protection-pause vol.1 2023-03-24 15:11:47 +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
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.