mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2025-01-01 11:38:18 +03:00
Code Issues Projects Releases Packages Wiki Activity
AdGuardHome/openapi
History
Eugene Burkov 261c1599a5 Pull request #2325: 7510 Fix openapi spec 
Merge in DNS/adguard-home from 7510-fix-openapi to master

Squashed commit of the following:

commit b67d6f964081cf12bea5c3406eba64a432d02e81
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 19 15:28:46 2024 +0300

    openapi: fmt openapi chlog

commit 738becf0af96b3bfc4b549be9ad84cbce0d9cf39
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 19 14:44:36 2024 +0300

    openapi: log changes

commit a398712ed1b5696f944f15404e340e002822c89f
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 19 14:34:11 2024 +0300

    openapi: fix spec
2024-12-19 15:38:18 +03:00
..
CHANGELOG.md Pull request #2325: 7510 Fix openapi spec 2024-12-19 15:38:18 +03:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
openapi.yaml Pull request #2325: 7510 Fix openapi spec 2024-12-19 15:38:18 +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.