Verified Commit 08aaa8fa authored by Roman Lacko's avatar Roman Lacko
Browse files

Remove documentation for API methods 

Perl POD documentation for these modules is virtually impossible to
maintain and is basically just copied from Web sources, which are
referenced in said Perl POD anyway.
parent 43d87610

GitLab/Commits.pm

+0 −62
Original line number Diff line number Diff line
@@ -88,68 +88,6 @@ GitLab::Commits - implements commits API calls 
See L<GitLab API -- Commits|https://docs.gitlab.com/ee/api/commits.html> for details and

response formats.



=head1 VERSION



Implements API calls for GitLab EE C<v11.4.4>.



=head1 DESCRIPTION



=head2 Notation



Please see the documentation for the L<GitLab::Users> module.



Note that not all optional arguments are listed.

Please refer to the official documentation for the full list.





=head2 Commits



=over



=item L<commits()|https://docs.gitlab.com/ee/api/commits.html#list-repository-commits>



    $gitlab->commits( :pid [,...] );



List repository commits.



=item L<commit_get()|https://docs.gitlab.com/ee/api/commits.html#get-a-single-commit>



    $gitlab->commit_get( :pid, :sha [, :stats] );



Get a single commit.



=item L<get_references()|https://docs.gitlab.com/ee/api/commits.html#get-references-a-commit-is-pushed-to>



    $gitlab->get_references( :pid, :sha [, :type] );



Get references a commit is pushed to.



=item L<cherry_pick()|https://docs.gitlab.com/ee/api/commits.html#cherry-pick-a-commit>



    $gitlab->cherry_pick( :pid, :sha, :branch );



Cherry pick a commit to a given branch.



=item L<commit_revert()|https://docs.gitlab.com/ee/api/commits.html#revert-a-commit>



    $gitlab->commit_revert( :pid, :sha, :branch );



Reverts a commit in a given branch.



=item L<commit_diff()|https://docs.gitlab.com/ee/api/commits.html#get-the-diff-of-a-commit>



    $gitlab->commit_diff( :pid, :sha );



Get the diff of a commit in a project.



=item L<commit_comments()|https://docs.gitlab.com/ee/api/commits.html#get-the-comments-of-a-commit>



    $gitlab->commit_comments( :pid, :sha );



Get the comments of a commit in a project.



=back



=head1 AUTHOR



Roman Lacko <L<xlacko1@fi.muni.cz>>

GitLab/CustomAttributes.pm

+0 −47
Original line number Diff line number Diff line
@@ -73,53 +73,6 @@ GitLab::CustomAttributes - implements custom attributes API 
See L<GitLab API -- Custom Attributes|https://docs.gitlab.com/ce/api/custom_attributes.html>

for details and response formats.



=head1 VERSION



Implements API calls for GitLab CE C<v10.4.1>.



=head1 DESCRIPTION



B<All of these methods require administrator permissions.>



The methods behave same for users, groups and projects.



=over



=item L<List custom attributes|https://docs.gitlab.com/ce/api/custom_attributes.html#list-custom-attributes>



    $attributes = $gitlab->user_custom_attributes( :uid );

    $attributes = $gitlab->group_custom_attributes( :gid );

    $attributes = $gitlab->project_custom_attributes( :id );



Returns a list of custom attributes.



=item L<Single custom attribute|https://docs.gitlab.com/ce/api/custom_attributes.html#single-custom-attribute>



    $attribute = $gitlab->user_get_custom_attribute( :uid, :key );

    $attribute = $gitlab->group_get_custom_attribute( :gid, :key );

    $attribute = $gitlab->project_get_custom_attribute( :id, :key );



Retrieves a single attribute.



=item L<Set custom attribute|https://docs.gitlab.com/ce/api/custom_attributes.html#set-custom-attribute>



    $gitlab->user_set_custom_attribute( :uid, :key, :value );

    $gitlab->group_set_custom_attribute( :gid, :key, :value );

    $gitlab->project_set_custom_attribute( :id, :key, :value );



Sets the custom attribute to the given value. The attribute will be created

if necessary.



=item L<Delete custom attribute|https://docs.gitlab.com/ce/api/custom_attributes.html#delete-custom-attribute>



    $gitlab->user_delete_custom_attribute( :uid, :key );

    $gitlab->group_delete_custom_attribute( :gid, :key );

    $gitlab->project_delete_custom_attribute( :id, :key );



Deletes a custom attribute.



=back



=head1 AUTHOR



Roman Lacko <L<xlacko1@fi.muni.cz>>

GitLab/Events.pm

+0 −32
Original line number Diff line number Diff line
@@ -70,38 +70,6 @@ GitLab::Events - implements events API calls 
See L<GitLab API -- Events|https://docs.gitlab.com/ce/api/events.html> for details and

response formats.



=head1 VERSION



Implements API calls for GitLab CE C<v10.4.1>.



=head1 DESCRIPTION



=over



=item L<self_events()|https://docs.gitlab.com/ce/api/events.html#list-currently-authenticated-user-39-s-events>



    $events = $gitlab->self_events( [:action,] [:target_type,] ... );



Returns events associated with the authenticated user.



=item L<user_events()|https://docs.gitlab.com/ce/api/events.html#get-user-contribution-events>



    $events = $gitlab->user_events( :uid, [:action,] [:target_type,] ... );



Returns contribution events for the given user.



=item L<project_events()|https://docs.gitlab.com/ce/api/events.html#list-a-project-39-s-visible-events>



    $events = $gitlab->project_events( :uid, [:action,] [:target_type,] ... );



Returns events associated with the given project.



=back



=head1 AUTHOR



Roman Lacko <L<xlacko1@fi.muni.cz>>



=head1 SEE ALSO



=over

GitLab/Groups.pm

+0 −90
Original line number Diff line number Diff line
@@ -131,96 +131,6 @@ GitLab::Groups - implements group API calls 
See L<GitLab API -- Groups|http://doc.gitlab.com/ce/api/groups.html> for details and

response formats.



=head1 VERSION



Implements API calls for GitLab CE C<v10.4.1>.



=head1 DESCRIPTION



=head2 Notation



Please see the documentation for the L<GitLab::Users> module.



Note that not all optional arguments are listed.

Please refer to the official documentation for the full list.



=head2 Group CRUD operations



=over



=item L<groups()|https://docs.gitlab.com/ce/api/groups.html#list-groups>



    $groups = $gitlab->groups( [:search] [:all_available] [:owned] );



Returns a list of groups.

An optional parameter C<search> can be used to filter the list by substring match on C<name>.



=item L<subgroups()|https://docs.gitlab.com/ce/api/groups.html#list-a-groups-39-s-subgroups>



    $subgroups = $gitlab->subgroups( :gid );



Returns subgroups of the given group.

Accepts same filtering parameters as L</groups()>.



=item L<group_details()|https://docs.gitlab.com/ce/api/groups.html#details-of-a-group>



    $details = $gitlab->group_details( :gid );



Returns details about a group with the given C<gid>.



=item L<group_create()|https://docs.gitlab.com/ce/api/groups.html#new-group>



    $group = $gitlab->group_create( :name, :path, [:description], [:visibility] );



Creates a new group. Required arguments are



    name                the name of the group,

    path                the path for the group (must be unique)



In addition, the following I<optional> arguments can be specified:



    description         group's description

    visibility          see GitLab::API for possible values



=item L<group_update()|https://docs.gitlab.com/ce/api/groups.html#update-group>



    $group = $gitlab->group_update( :gid );



Updates the grup with the given C<gid>.

Takes same arguments as C<group_create>, except they are all optional.



=item L<group_delete()|https://docs.gitlab.com/ce/api/groups.html#remove-group>



    $gitlab->group_delete( :gid );



Deletes the group with the given C<gid>.



=back



=head2 Group members



This section was moved to a separate module L<GitLab::Members>.



=head2 Group projects and transfer



=over



=item L<group_get_projects()|https://docs.gitlab.com/ce/api/groups.html#list-a-group-39-s-projects>



    $projects = $gitlab->group_get_projects( :gid );



Returns a list of projects owned by the group with the given C<gid>.



=item L<transfer_project_to_group()|https://docs.gitlab.com/ce/api/groups.html#transfer-project-to-group>



    $gitlab->transfer_project_to_group( :gid, :projid );



Moves the project with C<projid> to the namespace of the group with the given C<gid>.



I<This method is available only for administrators.>



=back



=head1 AUTHOR



Roman Lacko <L<xlacko1@fi.muni.cz>>

GitLab/Jobs.pm

+0 −58
Original line number Diff line number Diff line
@@ -83,64 +83,6 @@ GitLab::Jobs - implements jobs API calls 
See L<GitLab API -- Jobs|https://docs.gitlab.com/ee/api/jobs.html> for details and

response formats.



=head1 VERSION



Implements API calls for GitLab CE C<v10.4.1>.



=head1 DESCRIPTION



=over



=item L<project_jobs()|https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs>



    $jobs = $gitlab->project_jobs( :pid[, :scope]);



Get a list of jobs in a project.



=item L<pipeline_jobs()|https://docs.gitlab.com/ee/api/jobs.html#list-pipeline-jobs>



    $jobs = $gitlab->pipeline_jobs( :pid, :pipeline_id[, :scope]);



Get a list of jobs for a pipeline.



=item L<job()|https://docs.gitlab.com/ee/api/jobs.html#get-a-single-job>



    $jobs = $gitlab->job( :pid, :job_id );



Get a single job of a project.



=item L<job_cancel()|https://docs.gitlab.com/ee/api/jobs.html#cancel-a-job>



    $gitlab->job_cancel( :pid, :job_id );



Cancel a single job of a project.



=item L<job_retry()|https://docs.gitlab.com/ee/api/jobs.html#retry-a-job>



    $gitlab->job_retry( :pid, :job_id );



Retry a single job of a project.



=item L<job_erase()|https://docs.gitlab.com/ee/api/jobs.html#erase-a-job>



    $gitlab->job_erase( :pid, :job_id );



Erase a single job of a project (remove job artifacts and a job trace).



=item L<keep_artifacts()|https://docs.gitlab.com/ee/api/jobs.html#keep-artifacts>



    $gitlab->keep_artifacts( :pid, :job_id );



Prevents artifacts from being deleted when expiration is set.



=item L<job_play()|https://docs.gitlab.com/ee/api/jobs.html#play-a-job>



    $gitlab->job_play( :pid, :job_id );



Triggers a manual action to start a job.



=back



=head1 AUTHOR



Roman Lacko <L<xlacko1@fi.muni.cz>>