Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Kea
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Incidents
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Pavel Zhukov
Kea
Commits
057eb281
Commit
057eb281
authored
Oct 02, 2018
by
Tomek Mrugalski
🛰
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[#10,!3] Template updated.
parent
88c2621c
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
2 deletions
+30
-2
doc/api/_template.json
doc/api/_template.json
+30
-2
No files found.
doc/api/_template.json
View file @
057eb281
{
//
This
specifies
the
name
of
the
command.
Must
be
the
same
as
the
filename.
"name"
:
"template-command"
,
//
This
provides
a
short
description.
"brief"
:
"a sentence or two explaining what it is"
,
"support"
:
[
"kea-dhcp4"
,
"kea-dhcp6"
],
"avail"
:
"first version, possible a hook library name and (premium) if applicable"
,
//
This
provides
a
full
description.
Since
we
have
most
(all?)
commands
//
already
documented
,
we
don't
want
to
copy
over
the
text.
Instead
,
//
we
provide
links
to
specific
section.
"description"
:
"See <xref linkend=
\"
anchor-in-the-docs
\"
/>"
,
//
This
enumerates
the
daemons
that
are
able
to
handle
specific
command.
//
Usually
this
will
be
a
subset
of
those
specifeid
below
as
there
are
very
//
few
commands
that
are
supported
by
every
daemon.
"support"
:
[
"kea-dhcp4"
,
"kea-dhcp6"
,
"dhcp-ddns"
,
"ca"
,
"netconf"
],
//
Historical
information.
May
need
a
bit
of
digging
,
but
this
info
can
//
be
extracted
by
looking
at
older
Kea
user
guides.
We
have
them
published
//
on
FTP.
"avail"
:
"first version the command appeared in"
,
//
Many
commands
are
provided
by
a
hook.
Specify
the
name
of
the
hook
here.
//
If
this
hook
is
provided
by
the
deamons
natively
(without
needing
to
load
//
a
hook)
,
remove
the
whole
"hook"
entry.
"hook"
:
"name of the hook that provides this command. remove if provided by
the core code"
,
//
This
defines
a
syntax
of
the
command
"cmd-syntax"
:
"Syntax of the command"
,
//
This
defines
a
description
printed
immediately
below
the
command
syntax.
"cmd-comment"
:
"Possibly some extra comments after the syntax."
,
//
This
defines
a
syntax
of
the
response
"resp-syntax"
:
"Syntax of the response"
,
//
This
defines
a
description
printed
immediately
below
th
response
syntax.
"resp-comment"
:
"Optional extra comments after the respone syntax."
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment