Merge pull request #2696 from pi-hole/fix/api_dns_upstreams_docs

Fix API specs and example for dns.upstreams in config.yaml
This commit is contained in:
Dominik
2025-11-08 12:03:11 +01:00
committed by GitHub
2 changed files with 4 additions and 4 deletions

View File

@@ -500,8 +500,8 @@ int get_json_config(struct ftl_conn *api, cJSON *json, const bool detailed)
continue;
// Check equality of paths up to the requested level (if any)
// Examples:
// requested was /config/dnsmasq -> skip all entries that do not start in dnsmasq.
// requested was /config/dnsmasq/dhcp -> skip all entries that do not start in dhcp
// requested was /config/dns -> skip all entries that do not start in dns
// requested was /config/dns/dhcp -> skip all entries that do not start in dhcp
// etc.
if(!check_paths_equal(conf_item->p, requested_path, min_level - 1))
continue;

View File

@@ -919,7 +919,7 @@ components:
error:
key: "bad_request"
message: "Invalid path depth"
hint: "Use, e.g., DELETE /config/dnsmasq/upstreams/127.0.0.1 to remove \"127.0.0.1\" from config.dns.upstreams"
hint: "Use, e.g., DELETE /config/dns/upstreams/127.0.0.1 to remove \"127.0.0.1\" from config.dns.upstreams"
took: 0.003
item_already_present:
summary: Item to be added exists already
@@ -946,7 +946,7 @@ components:
type: string
required: true
description: config element
example: "dnsmasq/upstreams"
example: "dns/upstreams"
value:
in: path
name: value