.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "App::KGB::API 3pm"
.TH App::KGB::API 3pm "2024-01-01" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
App::KGB::API \-\- KGB bot API documentation
.SH "VERSION 4 (JSON)"
.IX Header "VERSION 4 (JSON)"
.SS "General, authentication"
.IX Subsection "General, authentication"
Version 4 uses JSON-RPC as described in
<http://http://json\-rpc.org/wiki/specification> with one extension. Since all
requests are authenticated, two \s-1HTTP\s0 headers need to be included:
.IP "X\-KGB-Project: project-name" 4
.IX Item "X-KGB-Project: project-name"
.PD 0
.IP "X\-KGB-Auth: hash" 4
.IX Item "X-KGB-Auth: hash"
.PD
.PP
The project name is the string identifying the project on the server side, and
the hash is the hexadecimal representation of the \s-1SHA\-1\s0 hash calculated over
the following data:
.IP "Project password" 4
.IX Item "Project password"
This is the shared password known to the client and the server.
.IP "project-name" 4
.IX Item "project-name"
.PD 0
.IP "request-text" 4
.IX Item "request-text"
.PD
This is the JSON-encoded request text. The same that is sent in the \s-1HTTP\s0 body.
.SS "Commit notification"
.IX Subsection "Commit notification"
Request is a JSON-RPC call to a method called \fBcommit_v4\fR with a single
argument, which is a map with the following possible keys:
.IP "repo_id \fIproject-name\fR" 4
.IX Item "repo_id project-name"
.PD 0
.IP "rev_prefix \fIrevision-prefix\fR" 4
.IX Item "rev_prefix revision-prefix"
.PD
Usually \f(CW\*(C`r\*(C'\fR for Subversion commits
.IP "commit_id \fIcommit id\fR" 4
.IX Item "commit_id commit id"
Subversion revision, Git hash or just empty (for \s-1CVS\s0).
.IP "changes \fIchanges list\fR" 4
.IX Item "changes changes list"
A list of changes, encoded as strings. It is simple file name prepended with
\&\f(CW\*(C`(A)\*(C'\fR for added, \f(CW\*(C`(M)\*(C'\fR (or nothing) for modified and \f(CW\*(C`(D)\*(C'\fR for deleted. See
App::KGB::Change.
.IP "commit_log \fIlog message\fR" 4
.IX Item "commit_log log message"
.PD 0
.IP "author \fIuser/name\fR" 4
.IX Item "author user/name"
.IP "branch \fIbranch name\fR" 4
.IX Item "branch branch name"
.IP "module \fImodule name\fR" 4
.IX Item "module module name"
.IP "extra \fIadditional information\fR" 4
.IX Item "extra additional information"
.PD
A map with extra information. Currently \f(CW\*(C`web_link\*(C'\fR is the only member that the
server recognises.
.SS "Plain message relay"
.IX Subsection "Plain message relay"
The message relay calls are to the \fBrelay_message\fR method, with the only
argument the message to be relayed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBkgb\-client\fR\|(1), \fBkgb\-bot\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "Damyan Ivanov dmn@debian.org" 4
.IX Item "Damyan Ivanov dmn@debian.org"
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright (C) 2012 Damyan Ivanov
.PP
This program is free software; you can redistribute it and/or modify it under
the terms of the \s-1GNU\s0 General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
.PP
This program is distributed in the hope that it will be useful, but \s-1WITHOUT
ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS
FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0 General Public License for more
details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, \s-1MA\s0  02110\-1301, \s-1USA.\s0