.\" 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
.\" ========================================================================
.\"
.IX Title "Pithub::Search 3pm"
.TH Pithub::Search 3pm "2023-09-02" "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"
Pithub::Search \- Github legacy Search API
.SH "VERSION"
.IX Header "VERSION"
version 0.01041
.SH "METHODS"
.IX Header "METHODS"
.SS "email"
.IX Subsection "email"
.IP "\(bu" 4
This \s-1API\s0 call is added for compatibility reasons only. There's
no guarantee that full email searches will always be available.
.Sp
.Vb 1
\&    GET /legacy/user/email/:email
.Ve
.Sp
Examples:
.Sp
.Vb 4
\&    my $search = Pithub::Search\->new;
\&    my $result = $search\->email(
\&        email => \*(Aqplu@pqpq.de\*(Aq,
\&    );
.Ve
.SS "issues"
.IX Subsection "issues"
.IP "\(bu" 4
Find issues by state and keyword.
.Sp
.Vb 1
\&    GET /legacy/issues/search/:owner/:repository/:state/:keyword
.Ve
.Sp
Examples:
.Sp
.Vb 7
\&    my $search = Pithub::Search\->new;
\&    my $result = $search\->issues(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        state   => \*(Aqopen\*(Aq,
\&        keyword => \*(Aqsome keyword\*(Aq,
\&    );
.Ve
.SS "repos"
.IX Subsection "repos"
.IP "\(bu" 4
Find repositories by keyword. Note, this legacy method does not
follow the v3 pagination pattern. This method returns up to 100
results per page and pages can be fetched using the start_page
parameter.
.Sp
.Vb 1
\&    GET /legacy/repos/search/:keyword
.Ve
.Sp
Examples:
.Sp
.Vb 8
\&    my $search = Pithub::Search\->new;
\&    my $result = $search\->repos(
\&        keyword => \*(Aqgithub\*(Aq,
\&        params  => {
\&            language   => \*(AqPerl\*(Aq,
\&            start_page => 0,
\&        }
\&    );
.Ve
.SS "users"
.IX Subsection "users"
.IP "\(bu" 4
Find users by keyword.
.Sp
.Vb 1
\&    GET /legacy/user/search/:keyword
.Ve
.Sp
Examples:
.Sp
.Vb 4
\&    my $search = Pithub::Search\->new;
\&    my $result = $search\->users(
\&        keyword => \*(Aqplu\*(Aq,
\&    );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Johannes Plunien <plu@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Johannes Plunien.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.