mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AdGuardHome/openapi
History
Dimitry Kolyshev e1995408e4 Pull request: 6263 custom ups cache 
Updates #6263.

Squashed commit of the following:

commit f6b704fb58
Merge: 780d001ce 5dd10d9fc
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Nov 24 09:55:04 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 780d001cef
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Nov 24 09:53:46 2023 +0200

    all: imp locales

commit 820bcf0e23
Merge: e7ca51563 1320043e9
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Thu Nov 23 11:16:54 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

    # Conflicts:
    #	CHANGELOG.md

commit e7ca515630
Merge: 23392d08b 0f5e8ca56
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:49:32 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 23392d08b1
Merge: a09cd190c feb15745d
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:49:10 2023 +0200

    Merge remote-tracking branch 'origin/6263-custom-ups-cache' into 6263-custom-ups-cache

commit a09cd190c0
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:48:43 2023 +0200

    home: imp code

commit feb15745d2
Author: Ildar Kamalov <ik@adguard.com>
Date:   Tue Nov 21 17:27:38 2023 +0300

    client: move cache fields to the upstream tab

commit 789060e4d4
Author: Ildar Kamalov <ik@adguard.com>
Date:   Tue Nov 21 16:28:03 2023 +0300

    client: add form fields

commit a700bfb42e
Merge: 7669419b5 db42254d7
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Nov 21 11:44:14 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 7669419b59
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Nov 21 11:34:17 2023 +0200

    home: imp code

commit 4a9dc1d6c1
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Nov 20 15:08:44 2023 +0200

    docs: http client docs

commit 944e0d7a4b
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Nov 20 13:51:00 2023 +0200

    home: http client dns cache
 		2023-11-24 15:20:32 +03:00
..
CHANGELOG.md Pull request: 6263 custom ups cache 2023-11-24 15:20:32 +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: 6263 custom ups cache 2023-11-24 15:20:32 +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.