From: Francis Dupont Date: Tue, 13 Aug 2019 09:03:00 +0000 (+0200) Subject: [826-documentation-of-cb_cmds-embedded-commands] Added API files X-Git-Tag: Kea-1.6.0~41^2~87 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f4705d620714ca52669fb4ed5d03157dffca7393;p=thirdparty%2Fkea.git [826-documentation-of-cb_cmds-embedded-commands] Added API files --- diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am index e41ed80944..83b2487efb 100644 --- a/doc/sphinx/Makefile.am +++ b/doc/sphinx/Makefile.am @@ -80,6 +80,20 @@ mes_files=$(foreach mf,$(mes_files1), $(top_srcdir)/$(mf)) # list of api files that are used to generate api.rst api_files1=$(shell cat api-files.txt) api_files=$(foreach af,$(api_files1), $(srcdir)/$(af)) +api_files+=$(srcdir)/api/remote-option4-network-del.json +api_files+=$(srcdir)/api/remote-option4-network-set.json +api_files+=$(srcdir)/api/remote-option4-pool-del.json +api_files+=$(srcdir)/api/remote-option4-pool-set.json +api_files+=$(srcdir)/api/remote-option4-subnet-del.json +api_files+=$(srcdir)/api/remote-option4-subnet-set.json +api_files+=$(srcdir)/api/remote-option6-network-del.json +api_files+=$(srcdir)/api/remote-option6-network-set.json +api_files+=$(srcdir)/api/remote-option6-pd-pool-del.json +api_files+=$(srcdir)/api/remote-option6-pd-pool-set.json +api_files+=$(srcdir)/api/remote-option6-pool-del.json +api_files+=$(srcdir)/api/remote-option6-pool-set.json +api_files+=$(srcdir)/api/remote-option6-subnet-del.json +api_files+=$(srcdir)/api/remote-option6-subnet-set.json EXTRA_DIST += mes-files.txt EXTRA_DIST += api-files.txt diff --git a/doc/sphinx/api/cmds-list b/doc/sphinx/api/cmds-list index bcfaf87c37..35f448ca4b 100644 --- a/doc/sphinx/api/cmds-list +++ b/doc/sphinx/api/cmds-list @@ -83,6 +83,20 @@ remote-option6-global-del remote-option6-global-get remote-option6-global-get-all remote-option6-global-set +remote-option4-network-del +remote-option4-network-set +remote-option4-pool-del +remote-option4-pool-set +remote-option4-subnet-del +remote-option4-subnet-set +remote-option6-network-del +remote-option6-network-set +remote-option6-pd-pool-del +remote-option6-pd-pool-set +remote-option6-pool-del +remote-option6-pool-set +remote-option6-subnet-del +remote-option6-subnet-set remote-server4-del remote-server4-get remote-server4-get-all diff --git a/doc/sphinx/api/remote-option4-network-del.json b/doc/sphinx/api/remote-option4-network-del.json new file mode 100644 index 0000000000..0304e26add --- /dev/null +++ b/doc/sphinx/api/remote-option4-network-del.json @@ -0,0 +1,44 @@ +{ + "avail": "1.6.0", + "brief": [ + "This command deletes a DHCPv4 shared network option from the configuration database." + ], + "cmd-comment": [ + "This command includes two lists with exactly one name of the shared network and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." + ], + "cmd-syntax": [ + "{", + " \"command\": \"remote-option4-network-del\",", + " \"arguments\": {", + " \"shared-networks\": [", + " {", + " \"name\": ", + " }", + " ],", + " \"options\": [", + " {", + " \"code\":