1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
=pod
The C<author/> directory contains the logic for generating the v4.pm
module.
=head1 DATA FILES
The C<author/config.yml> drives the order and configuration of
individual sections.
The YAML files in the C<author/sections/> directory have lines
like this:
- SUB: HTTP_METHOD PATH
- SUB: RETURN = HTTP_METHOD PATH?
=head2 SUB
The name of the subroutine that will be created in v4.pm.
=head2 RETURN
The name of the return variable if any. This is used as part of
generating the documentation. If no return variable is declared
then the subroutine will return an empty list no matter what
the API response returns.
=head2 HTTP_METHOD
One of GET, POST, PUT, or DELETE.
=head2 PATH
The path to the API endpoint (after the /api/v4 bit).
The path is a list of static and dynamic strings separate by
forward slashes. So, if you have:
/foo/:bar/baz
Then the API subroutine would require one argument which would
be injected in place of C<:bar>.
=head2 ?
If the PATH ends with a C<?> then this signifies that the API
endpoint accepts query parameters.
=head1 GENERATING
To generate C<lib/GitLab/API/v4.pm> do this:
cd author
perl generate.pl > ../lib/GitLab/API/v4.pm
=cut
|
