From: Vasek Sraier Date: Mon, 9 Jan 2023 22:20:12 +0000 (+0100) Subject: doc: fix links X-Git-Tag: v6.0.0a1~11^2~1 X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=b13d527b785b768b388cbf0f4cebabc9006dc481;p=thirdparty%2Fknot-resolver.git doc: fix links --- diff --git a/doc/config-overview.rst b/doc/config-overview.rst index a4be867ca..0e1b222df 100644 --- a/doc/config-overview.rst +++ b/doc/config-overview.rst @@ -12,8 +12,8 @@ Different configuration file can be loaded by using command line option Syntax ====== -The configuration file uses `YAML format version 1.1 _`. -To quickly learn about the format, you can have a look at `Learn YAML in Y minutes _`. +The configuration file uses `YAML format version 1.1 `_. +To quickly learn about the format, you can have a look at `Learn YAML in Y minutes `_. Schema diff --git a/doc/config-schema.rst b/doc/config-schema.rst index 25b92c4cc..769587d26 100644 --- a/doc/config-schema.rst +++ b/doc/config-schema.rst @@ -2,14 +2,14 @@ Configuration schema ==================== -The configuration schema describes the structure of accepted configuration files (or objects via the API). While originally specified in Python source code, it can be visualized as a `JSON schema _`. +The configuration schema describes the structure of accepted configuration files (or objects via the API). While originally specified in Python source code, it can be visualized as a `JSON schema `_. Getting the JSON schema ----------------------- 1. The JSON schema can be obtained from a running Resolver by sending a HTTP GET request to the path ``/schema`` on the management socket (by default a Unix socket at ``/var/run/knot-resolver/manager.sock``). 2. The ``kresctl schema`` command outputs the schema of the currently installed version as well. It does not require a running resolver. -3. JSON schema for the most recent Knot Resolver version can be `downloaded here <_static/config.schema.json>_`. +3. JSON schema for the most recent Knot Resolver version can be `downloaded here <_static/config.schema.json>`_. Validating you configuration ---------------------------- diff --git a/doc/manager-api.rst b/doc/manager-api.rst index 29f5fb8f1..592710903 100644 --- a/doc/manager-api.rst +++ b/doc/manager-api.rst @@ -52,6 +52,9 @@ HTTP request methods Operation In the case of an attempt to configure such an option, the operation is rejected. +----------------------------------- + + =================================== @@ -102,7 +105,7 @@ The different HTTP methods perform different modifications of the configuration: - ``GET`` return subtree of the current configuration - ``PUT`` set property - ``DELETE`` removes the given property or list item at the given index -- ``PATCH`` updates the configuration using `JSON Patch _` +- ``PATCH`` updates the configuration using `JSON Patch `_ To prevent race conditions when changing configuration from multiple clients simultaneously, every response from the Manager has an ``ETag`` header set. Requests then accept ``If-Match`` and ``If-None-Match`` headers with the latest ``ETag`` value and the corresponding request processing fails with HTTP error code 412 (precondition failed).