swaggy_jenkins 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/README.md +249 -0
- data/Rakefile +8 -0
- data/docs/AllView.md +10 -0
- data/docs/BlueOceanApi.md +2034 -0
- data/docs/Body.md +8 -0
- data/docs/BranchImpl.md +20 -0
- data/docs/BranchImpllinks.md +12 -0
- data/docs/BranchImplpermissions.md +12 -0
- data/docs/CauseAction.md +9 -0
- data/docs/CauseUserIdCause.md +11 -0
- data/docs/ClassesByClass.md +9 -0
- data/docs/ClockDifference.md +9 -0
- data/docs/ComputerSet.md +12 -0
- data/docs/DefaultCrumbIssuer.md +10 -0
- data/docs/DiskSpaceMonitorDescriptorDiskSpace.md +11 -0
- data/docs/EmptyChangeLogSet.md +9 -0
- data/docs/ExtensionClassContainerImpl1.md +10 -0
- data/docs/ExtensionClassContainerImpl1links.md +9 -0
- data/docs/ExtensionClassContainerImpl1map.md +10 -0
- data/docs/ExtensionClassImpl.md +10 -0
- data/docs/ExtensionClassImpllinks.md +9 -0
- data/docs/FavoriteImpl.md +10 -0
- data/docs/FavoriteImpllinks.md +9 -0
- data/docs/FreeStyleBuild.md +25 -0
- data/docs/FreeStyleProject.md +34 -0
- data/docs/FreeStyleProjectactions.md +8 -0
- data/docs/FreeStyleProjecthealthReport.md +12 -0
- data/docs/GenericResource.md +13 -0
- data/docs/GithubContent.md +15 -0
- data/docs/GithubFile.md +9 -0
- data/docs/GithubOrganization.md +11 -0
- data/docs/GithubOrganizationlinks.md +10 -0
- data/docs/GithubRepositories.md +13 -0
- data/docs/GithubRepositorieslinks.md +9 -0
- data/docs/GithubRepository.md +15 -0
- data/docs/GithubRepositorylinks.md +9 -0
- data/docs/GithubRepositorypermissions.md +11 -0
- data/docs/GithubRespositoryContainer.md +10 -0
- data/docs/GithubRespositoryContainerlinks.md +9 -0
- data/docs/GithubScm.md +12 -0
- data/docs/GithubScmlinks.md +9 -0
- data/docs/Hudson.md +22 -0
- data/docs/HudsonMasterComputer.md +23 -0
- data/docs/HudsonMasterComputerexecutors.md +13 -0
- data/docs/HudsonMasterComputermonitorData.md +14 -0
- data/docs/HudsonassignedLabels.md +8 -0
- data/docs/InputStepImpl.md +14 -0
- data/docs/InputStepImpllinks.md +9 -0
- data/docs/Label1.md +8 -0
- data/docs/Link.md +9 -0
- data/docs/ListView.md +12 -0
- data/docs/MultibranchPipeline.md +21 -0
- data/docs/NullSCM.md +8 -0
- data/docs/Organisation.md +9 -0
- data/docs/Organisations.md +7 -0
- data/docs/Pipeline.md +15 -0
- data/docs/PipelineActivities.md +7 -0
- data/docs/PipelineActivity.md +22 -0
- data/docs/PipelineActivityartifacts.md +11 -0
- data/docs/PipelineBranches.md +7 -0
- data/docs/PipelineBranchesitem.md +16 -0
- data/docs/PipelineBranchesitemlatestRun.md +21 -0
- data/docs/PipelineBranchesitempullRequest.md +13 -0
- data/docs/PipelineBranchesitempullRequestlinks.md +9 -0
- data/docs/PipelineFolderImpl.md +14 -0
- data/docs/PipelineImpl.md +16 -0
- data/docs/PipelineImpllinks.md +12 -0
- data/docs/PipelineQueue.md +7 -0
- data/docs/PipelineRun.md +22 -0
- data/docs/PipelineRunImpl.md +22 -0
- data/docs/PipelineRunImpllinks.md +13 -0
- data/docs/PipelineRunNode.md +15 -0
- data/docs/PipelineRunNodeSteps.md +7 -0
- data/docs/PipelineRunNodeedges.md +9 -0
- data/docs/PipelineRunNodes.md +7 -0
- data/docs/PipelineRunSteps.md +7 -0
- data/docs/PipelineRunartifacts.md +11 -0
- data/docs/PipelineRuns.md +7 -0
- data/docs/PipelineStepImpl.md +16 -0
- data/docs/PipelineStepImpllinks.md +10 -0
- data/docs/PipelinelatestRun.md +22 -0
- data/docs/PipelinelatestRunartifacts.md +11 -0
- data/docs/Pipelines.md +7 -0
- data/docs/Queue.md +9 -0
- data/docs/QueueBlockedItem.md +19 -0
- data/docs/QueueItemImpl.md +12 -0
- data/docs/QueueLeftItem.md +20 -0
- data/docs/RemoteAccessApi.md +1151 -0
- data/docs/ResponseTimeMonitorData.md +10 -0
- data/docs/ScmOrganisations.md +7 -0
- data/docs/StringParameterDefinition.md +12 -0
- data/docs/StringParameterValue.md +10 -0
- data/docs/SwapSpaceMonitorMemoryUsage2.md +12 -0
- data/docs/UnlabeledLoadStatistics.md +8 -0
- data/docs/User.md +12 -0
- data/docs/UserFavorites.md +7 -0
- data/docs/Users.md +7 -0
- data/git_push.sh +55 -0
- data/lib/swaggy_jenkins.rb +134 -0
- data/lib/swaggy_jenkins/api/blue_ocean_api.rb +2200 -0
- data/lib/swaggy_jenkins/api/remote_access_api.rb +1166 -0
- data/lib/swaggy_jenkins/api_client.rb +389 -0
- data/lib/swaggy_jenkins/api_error.rb +38 -0
- data/lib/swaggy_jenkins/configuration.rb +209 -0
- data/lib/swaggy_jenkins/models/all_view.rb +206 -0
- data/lib/swaggy_jenkins/models/body.rb +193 -0
- data/lib/swaggy_jenkins/models/branch_impl.rb +298 -0
- data/lib/swaggy_jenkins/models/branch_impllinks.rb +224 -0
- data/lib/swaggy_jenkins/models/branch_implpermissions.rb +224 -0
- data/lib/swaggy_jenkins/models/cause_action.rb +199 -0
- data/lib/swaggy_jenkins/models/cause_user_id_cause.rb +215 -0
- data/lib/swaggy_jenkins/models/classes_by_class.rb +199 -0
- data/lib/swaggy_jenkins/models/clock_difference.rb +197 -0
- data/lib/swaggy_jenkins/models/computer_set.rb +226 -0
- data/lib/swaggy_jenkins/models/default_crumb_issuer.rb +206 -0
- data/lib/swaggy_jenkins/models/disk_space_monitor_descriptor_disk_space.rb +215 -0
- data/lib/swaggy_jenkins/models/empty_change_log_set.rb +197 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1.rb +206 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1links.rb +197 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1map.rb +206 -0
- data/lib/swaggy_jenkins/models/extension_class_impl.rb +208 -0
- data/lib/swaggy_jenkins/models/extension_class_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/favorite_impl.rb +206 -0
- data/lib/swaggy_jenkins/models/favorite_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/free_style_build.rb +343 -0
- data/lib/swaggy_jenkins/models/free_style_project.rb +428 -0
- data/lib/swaggy_jenkins/models/free_style_projectactions.rb +188 -0
- data/lib/swaggy_jenkins/models/free_style_projecthealth_report.rb +224 -0
- data/lib/swaggy_jenkins/models/generic_resource.rb +233 -0
- data/lib/swaggy_jenkins/models/github_content.rb +251 -0
- data/lib/swaggy_jenkins/models/github_file.rb +197 -0
- data/lib/swaggy_jenkins/models/github_organization.rb +215 -0
- data/lib/swaggy_jenkins/models/github_organizationlinks.rb +206 -0
- data/lib/swaggy_jenkins/models/github_repositories.rb +235 -0
- data/lib/swaggy_jenkins/models/github_repositorieslinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_repository.rb +251 -0
- data/lib/swaggy_jenkins/models/github_repositorylinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_repositorypermissions.rb +215 -0
- data/lib/swaggy_jenkins/models/github_respository_container.rb +206 -0
- data/lib/swaggy_jenkins/models/github_respository_containerlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_scm.rb +224 -0
- data/lib/swaggy_jenkins/models/github_scmlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/hudson.rb +320 -0
- data/lib/swaggy_jenkins/models/hudson_master_computer.rb +325 -0
- data/lib/swaggy_jenkins/models/hudson_master_computerexecutors.rb +233 -0
- data/lib/swaggy_jenkins/models/hudson_master_computermonitor_data.rb +242 -0
- data/lib/swaggy_jenkins/models/hudsonassigned_labels.rb +188 -0
- data/lib/swaggy_jenkins/models/input_step_impl.rb +244 -0
- data/lib/swaggy_jenkins/models/input_step_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/label1.rb +188 -0
- data/lib/swaggy_jenkins/models/link.rb +197 -0
- data/lib/swaggy_jenkins/models/list_view.rb +226 -0
- data/lib/swaggy_jenkins/models/multibranch_pipeline.rb +307 -0
- data/lib/swaggy_jenkins/models/null_scm.rb +188 -0
- data/lib/swaggy_jenkins/models/organisation.rb +197 -0
- data/lib/swaggy_jenkins/models/organisations.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline.rb +251 -0
- data/lib/swaggy_jenkins/models/pipeline_activities.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_activity.rb +316 -0
- data/lib/swaggy_jenkins/models/pipeline_activityartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipeline_branches.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitem.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitemlatest_run.rb +305 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitempull_request.rb +233 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitempull_requestlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/pipeline_folder_impl.rb +242 -0
- data/lib/swaggy_jenkins/models/pipeline_impl.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_impllinks.rb +224 -0
- data/lib/swaggy_jenkins/models/pipeline_queue.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run.rb +316 -0
- data/lib/swaggy_jenkins/models/pipeline_run_impl.rb +314 -0
- data/lib/swaggy_jenkins/models/pipeline_run_impllinks.rb +233 -0
- data/lib/swaggy_jenkins/models/pipeline_run_node.rb +253 -0
- data/lib/swaggy_jenkins/models/pipeline_run_node_steps.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run_nodeedges.rb +197 -0
- data/lib/swaggy_jenkins/models/pipeline_run_nodes.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run_steps.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_runartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipeline_runs.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_step_impl.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_step_impllinks.rb +206 -0
- data/lib/swaggy_jenkins/models/pipelinelatest_run.rb +316 -0
- data/lib/swaggy_jenkins/models/pipelinelatest_runartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipelines.rb +179 -0
- data/lib/swaggy_jenkins/models/queue.rb +199 -0
- data/lib/swaggy_jenkins/models/queue_blocked_item.rb +289 -0
- data/lib/swaggy_jenkins/models/queue_item_impl.rb +224 -0
- data/lib/swaggy_jenkins/models/queue_left_item.rb +298 -0
- data/lib/swaggy_jenkins/models/response_time_monitor_data.rb +206 -0
- data/lib/swaggy_jenkins/models/scm_organisations.rb +179 -0
- data/lib/swaggy_jenkins/models/string_parameter_definition.rb +224 -0
- data/lib/swaggy_jenkins/models/string_parameter_value.rb +206 -0
- data/lib/swaggy_jenkins/models/swap_space_monitor_memory_usage2.rb +224 -0
- data/lib/swaggy_jenkins/models/unlabeled_load_statistics.rb +188 -0
- data/lib/swaggy_jenkins/models/user.rb +224 -0
- data/lib/swaggy_jenkins/models/user_favorites.rb +179 -0
- data/lib/swaggy_jenkins/models/users.rb +179 -0
- data/lib/swaggy_jenkins/version.rb +15 -0
- data/spec/api/blue_ocean_api_spec.rb +513 -0
- data/spec/api/remote_access_api_spec.rb +304 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/all_view_spec.rb +54 -0
- data/spec/models/body_spec.rb +42 -0
- data/spec/models/branch_impl_spec.rb +114 -0
- data/spec/models/branch_impllinks_spec.rb +66 -0
- data/spec/models/branch_implpermissions_spec.rb +66 -0
- data/spec/models/cause_action_spec.rb +48 -0
- data/spec/models/cause_user_id_cause_spec.rb +60 -0
- data/spec/models/classes_by_class_spec.rb +48 -0
- data/spec/models/clock_difference_spec.rb +48 -0
- data/spec/models/computer_set_spec.rb +66 -0
- data/spec/models/default_crumb_issuer_spec.rb +54 -0
- data/spec/models/disk_space_monitor_descriptor_disk_space_spec.rb +60 -0
- data/spec/models/empty_change_log_set_spec.rb +48 -0
- data/spec/models/extension_class_container_impl1_spec.rb +54 -0
- data/spec/models/extension_class_container_impl1links_spec.rb +48 -0
- data/spec/models/extension_class_container_impl1map_spec.rb +54 -0
- data/spec/models/extension_class_impl_spec.rb +54 -0
- data/spec/models/extension_class_impllinks_spec.rb +48 -0
- data/spec/models/favorite_impl_spec.rb +54 -0
- data/spec/models/favorite_impllinks_spec.rb +48 -0
- data/spec/models/free_style_build_spec.rb +144 -0
- data/spec/models/free_style_project_spec.rb +198 -0
- data/spec/models/free_style_projectactions_spec.rb +42 -0
- data/spec/models/free_style_projecthealth_report_spec.rb +66 -0
- data/spec/models/generic_resource_spec.rb +72 -0
- data/spec/models/github_content_spec.rb +84 -0
- data/spec/models/github_file_spec.rb +48 -0
- data/spec/models/github_organization_spec.rb +60 -0
- data/spec/models/github_organizationlinks_spec.rb +54 -0
- data/spec/models/github_repositories_spec.rb +72 -0
- data/spec/models/github_repositorieslinks_spec.rb +48 -0
- data/spec/models/github_repository_spec.rb +84 -0
- data/spec/models/github_repositorylinks_spec.rb +48 -0
- data/spec/models/github_repositorypermissions_spec.rb +60 -0
- data/spec/models/github_respository_container_spec.rb +54 -0
- data/spec/models/github_respository_containerlinks_spec.rb +48 -0
- data/spec/models/github_scm_spec.rb +66 -0
- data/spec/models/github_scmlinks_spec.rb +48 -0
- data/spec/models/hudson_master_computer_spec.rb +132 -0
- data/spec/models/hudson_master_computerexecutors_spec.rb +72 -0
- data/spec/models/hudson_master_computermonitor_data_spec.rb +78 -0
- data/spec/models/hudson_spec.rb +126 -0
- data/spec/models/hudsonassigned_labels_spec.rb +42 -0
- data/spec/models/input_step_impl_spec.rb +78 -0
- data/spec/models/input_step_impllinks_spec.rb +48 -0
- data/spec/models/label1_spec.rb +42 -0
- data/spec/models/link_spec.rb +48 -0
- data/spec/models/list_view_spec.rb +66 -0
- data/spec/models/multibranch_pipeline_spec.rb +120 -0
- data/spec/models/null_scm_spec.rb +42 -0
- data/spec/models/organisation_spec.rb +48 -0
- data/spec/models/organisations_spec.rb +36 -0
- data/spec/models/pipeline_activities_spec.rb +36 -0
- data/spec/models/pipeline_activity_spec.rb +126 -0
- data/spec/models/pipeline_activityartifacts_spec.rb +60 -0
- data/spec/models/pipeline_branches_spec.rb +36 -0
- data/spec/models/pipeline_branchesitem_spec.rb +90 -0
- data/spec/models/pipeline_branchesitemlatest_run_spec.rb +120 -0
- data/spec/models/pipeline_branchesitempull_request_spec.rb +72 -0
- data/spec/models/pipeline_branchesitempull_requestlinks_spec.rb +48 -0
- data/spec/models/pipeline_folder_impl_spec.rb +78 -0
- data/spec/models/pipeline_impl_spec.rb +90 -0
- data/spec/models/pipeline_impllinks_spec.rb +66 -0
- data/spec/models/pipeline_queue_spec.rb +36 -0
- data/spec/models/pipeline_run_impl_spec.rb +126 -0
- data/spec/models/pipeline_run_impllinks_spec.rb +72 -0
- data/spec/models/pipeline_run_node_spec.rb +84 -0
- data/spec/models/pipeline_run_node_steps_spec.rb +36 -0
- data/spec/models/pipeline_run_nodeedges_spec.rb +48 -0
- data/spec/models/pipeline_run_nodes_spec.rb +36 -0
- data/spec/models/pipeline_run_spec.rb +126 -0
- data/spec/models/pipeline_run_steps_spec.rb +36 -0
- data/spec/models/pipeline_runartifacts_spec.rb +60 -0
- data/spec/models/pipeline_runs_spec.rb +36 -0
- data/spec/models/pipeline_spec.rb +84 -0
- data/spec/models/pipeline_step_impl_spec.rb +90 -0
- data/spec/models/pipeline_step_impllinks_spec.rb +54 -0
- data/spec/models/pipelinelatest_run_spec.rb +126 -0
- data/spec/models/pipelinelatest_runartifacts_spec.rb +60 -0
- data/spec/models/pipelines_spec.rb +36 -0
- data/spec/models/queue_blocked_item_spec.rb +108 -0
- data/spec/models/queue_item_impl_spec.rb +66 -0
- data/spec/models/queue_left_item_spec.rb +114 -0
- data/spec/models/queue_spec.rb +48 -0
- data/spec/models/response_time_monitor_data_spec.rb +54 -0
- data/spec/models/scm_organisations_spec.rb +36 -0
- data/spec/models/string_parameter_definition_spec.rb +66 -0
- data/spec/models/string_parameter_value_spec.rb +54 -0
- data/spec/models/swap_space_monitor_memory_usage2_spec.rb +66 -0
- data/spec/models/unlabeled_load_statistics_spec.rb +42 -0
- data/spec/models/user_favorites_spec.rb +36 -0
- data/spec/models/user_spec.rb +66 -0
- data/spec/models/users_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/swaggy_jenkins.gemspec +45 -0
- metadata +621 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f5191dc0376f18a6330dba9c90e1a230db13ef0f
|
4
|
+
data.tar.gz: b97f70e5d46473dc378d6773ae11f72fbd4fa000
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9037701fe66b3c1c720039b242777d794deabb6ea9f197636879b82c0a2cc675ce6c09e719dec55efbc9714edb1fde7d5c1ea49947adcf89a193421f3dcc821b
|
7
|
+
data.tar.gz: eee014caddbec8904da57e97c04aefdc751155b01b30036ef79eb878dcbd223ffd94a827381a3891e6a870d7833f6cf2ff90fd64695087d9b9598ef8840bdda4
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
swaggy_jenkins (0.0.1)
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.1)
|
12
|
+
addressable (2.5.1)
|
13
|
+
public_suffix (~> 2.0, >= 2.0.2)
|
14
|
+
autotest (4.4.6)
|
15
|
+
ZenTest (>= 4.4.1)
|
16
|
+
autotest-fsevent (0.2.12)
|
17
|
+
sys-uname
|
18
|
+
autotest-growl (0.2.16)
|
19
|
+
autotest-rails-pure (4.1.2)
|
20
|
+
crack (0.4.3)
|
21
|
+
safe_yaml (~> 1.0.0)
|
22
|
+
diff-lcs (1.3)
|
23
|
+
ethon (0.10.1)
|
24
|
+
ffi (>= 1.3.0)
|
25
|
+
ffi (1.9.18)
|
26
|
+
hashdiff (0.3.4)
|
27
|
+
json (2.1.0)
|
28
|
+
public_suffix (2.0.5)
|
29
|
+
rake (12.0.0)
|
30
|
+
rspec (3.6.0)
|
31
|
+
rspec-core (~> 3.6.0)
|
32
|
+
rspec-expectations (~> 3.6.0)
|
33
|
+
rspec-mocks (~> 3.6.0)
|
34
|
+
rspec-core (3.6.0)
|
35
|
+
rspec-support (~> 3.6.0)
|
36
|
+
rspec-expectations (3.6.0)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.6.0)
|
39
|
+
rspec-mocks (3.6.0)
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
+
rspec-support (~> 3.6.0)
|
42
|
+
rspec-support (3.6.0)
|
43
|
+
safe_yaml (1.0.4)
|
44
|
+
sys-uname (1.0.3)
|
45
|
+
ffi (>= 1.0.0)
|
46
|
+
typhoeus (1.1.2)
|
47
|
+
ethon (>= 0.9.0)
|
48
|
+
vcr (3.0.3)
|
49
|
+
webmock (1.24.6)
|
50
|
+
addressable (>= 2.3.6)
|
51
|
+
crack (>= 0.3.2)
|
52
|
+
hashdiff
|
53
|
+
|
54
|
+
PLATFORMS
|
55
|
+
ruby
|
56
|
+
|
57
|
+
DEPENDENCIES
|
58
|
+
autotest (~> 4.4, >= 4.4.6)
|
59
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
60
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
61
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
62
|
+
rake (~> 12.0.0)
|
63
|
+
rspec (~> 3.6, >= 3.6.0)
|
64
|
+
swaggy_jenkins!
|
65
|
+
vcr (~> 3.0, >= 3.0.1)
|
66
|
+
webmock (~> 1.24, >= 1.24.3)
|
67
|
+
|
68
|
+
BUNDLED WITH
|
69
|
+
1.15.3
|
data/README.md
ADDED
@@ -0,0 +1,249 @@
|
|
1
|
+
# swaggy_jenkins
|
2
|
+
|
3
|
+
SwaggyJenkinsClient - the Ruby gem for the Swaggy Jenkins
|
4
|
+
|
5
|
+
Jenkins API clients generated from Swagger / Open API specification
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 0.1.0
|
10
|
+
- Package version: 0.0.1
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [http://github.com/cliffano/swaggy-jenkins](http://github.com/cliffano/swaggy-jenkins)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build swaggy_jenkins.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./swaggy_jenkins-0.0.1.gem
|
28
|
+
```
|
29
|
+
(for development, run `gem install --dev ./swaggy_jenkins-0.0.1.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'swaggy_jenkins', '~> 0.0.1'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
40
|
+
|
41
|
+
gem 'swaggy_jenkins', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
```ruby
|
55
|
+
# Load the gem
|
56
|
+
require 'swaggy_jenkins'
|
57
|
+
|
58
|
+
# Setup authorization
|
59
|
+
SwaggyJenkinsClient.configure do |config|
|
60
|
+
# Configure HTTP basic authorization: jenkins_auth
|
61
|
+
config.username = 'YOUR USERNAME'
|
62
|
+
config.password = 'YOUR PASSWORD'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
66
|
+
|
67
|
+
organization = "organization_example" # String | Name of the organization
|
68
|
+
|
69
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
70
|
+
|
71
|
+
queue = "queue_example" # String | Name of the queue item
|
72
|
+
|
73
|
+
|
74
|
+
begin
|
75
|
+
api_instance.delete_pipeline_queue_item(organization, pipeline, queue)
|
76
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
77
|
+
puts "Exception when calling BlueOceanApi->delete_pipeline_queue_item: #{e}"
|
78
|
+
end
|
79
|
+
|
80
|
+
```
|
81
|
+
|
82
|
+
## Documentation for API Endpoints
|
83
|
+
|
84
|
+
All URIs are relative to *http://localhost*
|
85
|
+
|
86
|
+
Class | Method | HTTP request | Description
|
87
|
+
------------ | ------------- | ------------- | -------------
|
88
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**delete_pipeline_queue_item**](docs/BlueOceanApi.md#delete_pipeline_queue_item) | **DELETE** /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue/{queue} |
|
89
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_authenticated_user**](docs/BlueOceanApi.md#get_authenticated_user) | **GET** /blue/rest/organizations/{organization}/user/ |
|
90
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_classes**](docs/BlueOceanApi.md#get_classes) | **GET** /blue/rest/classes/{class} |
|
91
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_organisation**](docs/BlueOceanApi.md#get_organisation) | **GET** /blue/rest/organizations/{organization} |
|
92
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_organisations**](docs/BlueOceanApi.md#get_organisations) | **GET** /blue/rest/organizations/ |
|
93
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline**](docs/BlueOceanApi.md#get_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline} |
|
94
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_activities**](docs/BlueOceanApi.md#get_pipeline_activities) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/activities |
|
95
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_branch**](docs/BlueOceanApi.md#get_pipeline_branch) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/ |
|
96
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_branch_run**](docs/BlueOceanApi.md#get_pipeline_branch_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run} |
|
97
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_branches**](docs/BlueOceanApi.md#get_pipeline_branches) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches |
|
98
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_folder**](docs/BlueOceanApi.md#get_pipeline_folder) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/ |
|
99
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_folder_pipeline**](docs/BlueOceanApi.md#get_pipeline_folder_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline} |
|
100
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_queue**](docs/BlueOceanApi.md#get_pipeline_queue) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue |
|
101
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run**](docs/BlueOceanApi.md#get_pipeline_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run} |
|
102
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_log**](docs/BlueOceanApi.md#get_pipeline_run_log) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log |
|
103
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_node**](docs/BlueOceanApi.md#get_pipeline_run_node) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node} |
|
104
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_node_step**](docs/BlueOceanApi.md#get_pipeline_run_node_step) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step} |
|
105
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_node_step_log**](docs/BlueOceanApi.md#get_pipeline_run_node_step_log) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log |
|
106
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_node_steps**](docs/BlueOceanApi.md#get_pipeline_run_node_steps) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps |
|
107
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_run_nodes**](docs/BlueOceanApi.md#get_pipeline_run_nodes) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes |
|
108
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipeline_runs**](docs/BlueOceanApi.md#get_pipeline_runs) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs |
|
109
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_pipelines**](docs/BlueOceanApi.md#get_pipelines) | **GET** /blue/rest/organizations/{organization}/pipelines/ |
|
110
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_scm**](docs/BlueOceanApi.md#get_scm) | **GET** /blue/rest/organizations/{organization}/scm/{scm} |
|
111
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_scm_organisation_repositories**](docs/BlueOceanApi.md#get_scm_organisation_repositories) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories |
|
112
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_scm_organisation_repository**](docs/BlueOceanApi.md#get_scm_organisation_repository) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository} |
|
113
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_scm_organisations**](docs/BlueOceanApi.md#get_scm_organisations) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations |
|
114
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_user**](docs/BlueOceanApi.md#get_user) | **GET** /blue/rest/organizations/{organization}/users/{user} |
|
115
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_user_favorites**](docs/BlueOceanApi.md#get_user_favorites) | **GET** /blue/rest/users/{user}/favorites |
|
116
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**get_users**](docs/BlueOceanApi.md#get_users) | **GET** /blue/rest/organizations/{organization}/users/ |
|
117
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**post_pipeline_run**](docs/BlueOceanApi.md#post_pipeline_run) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay |
|
118
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**post_pipeline_runs**](docs/BlueOceanApi.md#post_pipeline_runs) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs |
|
119
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**put_pipeline_favorite**](docs/BlueOceanApi.md#put_pipeline_favorite) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite |
|
120
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**put_pipeline_run**](docs/BlueOceanApi.md#put_pipeline_run) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop |
|
121
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**search**](docs/BlueOceanApi.md#search) | **GET** /blue/rest/search/ |
|
122
|
+
*SwaggyJenkinsClient::BlueOceanApi* | [**search_classes**](docs/BlueOceanApi.md#search_classes) | **GET** /blue/rest/classes/ |
|
123
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_computer**](docs/RemoteAccessApi.md#get_computer) | **GET** /computer/api/json |
|
124
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_crumb**](docs/RemoteAccessApi.md#get_crumb) | **GET** /crumbIssuer/api/json |
|
125
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_jenkins**](docs/RemoteAccessApi.md#get_jenkins) | **GET** /api/json |
|
126
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_job**](docs/RemoteAccessApi.md#get_job) | **GET** /job/{name}/api/json |
|
127
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_job_config**](docs/RemoteAccessApi.md#get_job_config) | **GET** /job/{name}/config.xml |
|
128
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_job_last_build**](docs/RemoteAccessApi.md#get_job_last_build) | **GET** /job/{name}/lastBuild/api/json |
|
129
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_job_progressive_text**](docs/RemoteAccessApi.md#get_job_progressive_text) | **GET** /job/{name}/{number}/logText/progressiveText |
|
130
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_queue**](docs/RemoteAccessApi.md#get_queue) | **GET** /queue/api/json |
|
131
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_queue_item**](docs/RemoteAccessApi.md#get_queue_item) | **GET** /queue/item/{number}/api/json |
|
132
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_view**](docs/RemoteAccessApi.md#get_view) | **GET** /view/{name}/api/json |
|
133
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**get_view_config**](docs/RemoteAccessApi.md#get_view_config) | **GET** /view/{name}/config.xml |
|
134
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**head_jenkins**](docs/RemoteAccessApi.md#head_jenkins) | **HEAD** /api/json |
|
135
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_create_item**](docs/RemoteAccessApi.md#post_create_item) | **POST** /createItem |
|
136
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_create_view**](docs/RemoteAccessApi.md#post_create_view) | **POST** /createView |
|
137
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_build**](docs/RemoteAccessApi.md#post_job_build) | **POST** /job/{name}/build |
|
138
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_config**](docs/RemoteAccessApi.md#post_job_config) | **POST** /job/{name}/config.xml |
|
139
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_delete**](docs/RemoteAccessApi.md#post_job_delete) | **POST** /job/{name}/doDelete |
|
140
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_disable**](docs/RemoteAccessApi.md#post_job_disable) | **POST** /job/{name}/disable |
|
141
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_enable**](docs/RemoteAccessApi.md#post_job_enable) | **POST** /job/{name}/enable |
|
142
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_job_last_build_stop**](docs/RemoteAccessApi.md#post_job_last_build_stop) | **POST** /job/{name}/lastBuild/stop |
|
143
|
+
*SwaggyJenkinsClient::RemoteAccessApi* | [**post_view_config**](docs/RemoteAccessApi.md#post_view_config) | **POST** /view/{name}/config.xml |
|
144
|
+
|
145
|
+
|
146
|
+
## Documentation for Models
|
147
|
+
|
148
|
+
- [SwaggyJenkinsClient::AllView](docs/AllView.md)
|
149
|
+
- [SwaggyJenkinsClient::Body](docs/Body.md)
|
150
|
+
- [SwaggyJenkinsClient::BranchImpl](docs/BranchImpl.md)
|
151
|
+
- [SwaggyJenkinsClient::BranchImpllinks](docs/BranchImpllinks.md)
|
152
|
+
- [SwaggyJenkinsClient::BranchImplpermissions](docs/BranchImplpermissions.md)
|
153
|
+
- [SwaggyJenkinsClient::CauseAction](docs/CauseAction.md)
|
154
|
+
- [SwaggyJenkinsClient::CauseUserIdCause](docs/CauseUserIdCause.md)
|
155
|
+
- [SwaggyJenkinsClient::ClassesByClass](docs/ClassesByClass.md)
|
156
|
+
- [SwaggyJenkinsClient::ClockDifference](docs/ClockDifference.md)
|
157
|
+
- [SwaggyJenkinsClient::ComputerSet](docs/ComputerSet.md)
|
158
|
+
- [SwaggyJenkinsClient::DefaultCrumbIssuer](docs/DefaultCrumbIssuer.md)
|
159
|
+
- [SwaggyJenkinsClient::DiskSpaceMonitorDescriptorDiskSpace](docs/DiskSpaceMonitorDescriptorDiskSpace.md)
|
160
|
+
- [SwaggyJenkinsClient::EmptyChangeLogSet](docs/EmptyChangeLogSet.md)
|
161
|
+
- [SwaggyJenkinsClient::ExtensionClassContainerImpl1](docs/ExtensionClassContainerImpl1.md)
|
162
|
+
- [SwaggyJenkinsClient::ExtensionClassContainerImpl1links](docs/ExtensionClassContainerImpl1links.md)
|
163
|
+
- [SwaggyJenkinsClient::ExtensionClassContainerImpl1map](docs/ExtensionClassContainerImpl1map.md)
|
164
|
+
- [SwaggyJenkinsClient::ExtensionClassImpl](docs/ExtensionClassImpl.md)
|
165
|
+
- [SwaggyJenkinsClient::ExtensionClassImpllinks](docs/ExtensionClassImpllinks.md)
|
166
|
+
- [SwaggyJenkinsClient::FavoriteImpl](docs/FavoriteImpl.md)
|
167
|
+
- [SwaggyJenkinsClient::FavoriteImpllinks](docs/FavoriteImpllinks.md)
|
168
|
+
- [SwaggyJenkinsClient::FreeStyleBuild](docs/FreeStyleBuild.md)
|
169
|
+
- [SwaggyJenkinsClient::FreeStyleProject](docs/FreeStyleProject.md)
|
170
|
+
- [SwaggyJenkinsClient::FreeStyleProjectactions](docs/FreeStyleProjectactions.md)
|
171
|
+
- [SwaggyJenkinsClient::FreeStyleProjecthealthReport](docs/FreeStyleProjecthealthReport.md)
|
172
|
+
- [SwaggyJenkinsClient::GenericResource](docs/GenericResource.md)
|
173
|
+
- [SwaggyJenkinsClient::GithubContent](docs/GithubContent.md)
|
174
|
+
- [SwaggyJenkinsClient::GithubFile](docs/GithubFile.md)
|
175
|
+
- [SwaggyJenkinsClient::GithubOrganization](docs/GithubOrganization.md)
|
176
|
+
- [SwaggyJenkinsClient::GithubOrganizationlinks](docs/GithubOrganizationlinks.md)
|
177
|
+
- [SwaggyJenkinsClient::GithubRepositories](docs/GithubRepositories.md)
|
178
|
+
- [SwaggyJenkinsClient::GithubRepositorieslinks](docs/GithubRepositorieslinks.md)
|
179
|
+
- [SwaggyJenkinsClient::GithubRepository](docs/GithubRepository.md)
|
180
|
+
- [SwaggyJenkinsClient::GithubRepositorylinks](docs/GithubRepositorylinks.md)
|
181
|
+
- [SwaggyJenkinsClient::GithubRepositorypermissions](docs/GithubRepositorypermissions.md)
|
182
|
+
- [SwaggyJenkinsClient::GithubRespositoryContainer](docs/GithubRespositoryContainer.md)
|
183
|
+
- [SwaggyJenkinsClient::GithubRespositoryContainerlinks](docs/GithubRespositoryContainerlinks.md)
|
184
|
+
- [SwaggyJenkinsClient::GithubScm](docs/GithubScm.md)
|
185
|
+
- [SwaggyJenkinsClient::GithubScmlinks](docs/GithubScmlinks.md)
|
186
|
+
- [SwaggyJenkinsClient::Hudson](docs/Hudson.md)
|
187
|
+
- [SwaggyJenkinsClient::HudsonMasterComputer](docs/HudsonMasterComputer.md)
|
188
|
+
- [SwaggyJenkinsClient::HudsonMasterComputerexecutors](docs/HudsonMasterComputerexecutors.md)
|
189
|
+
- [SwaggyJenkinsClient::HudsonMasterComputermonitorData](docs/HudsonMasterComputermonitorData.md)
|
190
|
+
- [SwaggyJenkinsClient::HudsonassignedLabels](docs/HudsonassignedLabels.md)
|
191
|
+
- [SwaggyJenkinsClient::InputStepImpl](docs/InputStepImpl.md)
|
192
|
+
- [SwaggyJenkinsClient::InputStepImpllinks](docs/InputStepImpllinks.md)
|
193
|
+
- [SwaggyJenkinsClient::Label1](docs/Label1.md)
|
194
|
+
- [SwaggyJenkinsClient::Link](docs/Link.md)
|
195
|
+
- [SwaggyJenkinsClient::ListView](docs/ListView.md)
|
196
|
+
- [SwaggyJenkinsClient::MultibranchPipeline](docs/MultibranchPipeline.md)
|
197
|
+
- [SwaggyJenkinsClient::NullSCM](docs/NullSCM.md)
|
198
|
+
- [SwaggyJenkinsClient::Organisation](docs/Organisation.md)
|
199
|
+
- [SwaggyJenkinsClient::Organisations](docs/Organisations.md)
|
200
|
+
- [SwaggyJenkinsClient::Pipeline](docs/Pipeline.md)
|
201
|
+
- [SwaggyJenkinsClient::PipelineActivities](docs/PipelineActivities.md)
|
202
|
+
- [SwaggyJenkinsClient::PipelineActivity](docs/PipelineActivity.md)
|
203
|
+
- [SwaggyJenkinsClient::PipelineActivityartifacts](docs/PipelineActivityartifacts.md)
|
204
|
+
- [SwaggyJenkinsClient::PipelineBranches](docs/PipelineBranches.md)
|
205
|
+
- [SwaggyJenkinsClient::PipelineBranchesitem](docs/PipelineBranchesitem.md)
|
206
|
+
- [SwaggyJenkinsClient::PipelineBranchesitemlatestRun](docs/PipelineBranchesitemlatestRun.md)
|
207
|
+
- [SwaggyJenkinsClient::PipelineBranchesitempullRequest](docs/PipelineBranchesitempullRequest.md)
|
208
|
+
- [SwaggyJenkinsClient::PipelineBranchesitempullRequestlinks](docs/PipelineBranchesitempullRequestlinks.md)
|
209
|
+
- [SwaggyJenkinsClient::PipelineFolderImpl](docs/PipelineFolderImpl.md)
|
210
|
+
- [SwaggyJenkinsClient::PipelineImpl](docs/PipelineImpl.md)
|
211
|
+
- [SwaggyJenkinsClient::PipelineImpllinks](docs/PipelineImpllinks.md)
|
212
|
+
- [SwaggyJenkinsClient::PipelineQueue](docs/PipelineQueue.md)
|
213
|
+
- [SwaggyJenkinsClient::PipelineRun](docs/PipelineRun.md)
|
214
|
+
- [SwaggyJenkinsClient::PipelineRunImpl](docs/PipelineRunImpl.md)
|
215
|
+
- [SwaggyJenkinsClient::PipelineRunImpllinks](docs/PipelineRunImpllinks.md)
|
216
|
+
- [SwaggyJenkinsClient::PipelineRunNode](docs/PipelineRunNode.md)
|
217
|
+
- [SwaggyJenkinsClient::PipelineRunNodeSteps](docs/PipelineRunNodeSteps.md)
|
218
|
+
- [SwaggyJenkinsClient::PipelineRunNodeedges](docs/PipelineRunNodeedges.md)
|
219
|
+
- [SwaggyJenkinsClient::PipelineRunNodes](docs/PipelineRunNodes.md)
|
220
|
+
- [SwaggyJenkinsClient::PipelineRunSteps](docs/PipelineRunSteps.md)
|
221
|
+
- [SwaggyJenkinsClient::PipelineRunartifacts](docs/PipelineRunartifacts.md)
|
222
|
+
- [SwaggyJenkinsClient::PipelineRuns](docs/PipelineRuns.md)
|
223
|
+
- [SwaggyJenkinsClient::PipelineStepImpl](docs/PipelineStepImpl.md)
|
224
|
+
- [SwaggyJenkinsClient::PipelineStepImpllinks](docs/PipelineStepImpllinks.md)
|
225
|
+
- [SwaggyJenkinsClient::PipelinelatestRun](docs/PipelinelatestRun.md)
|
226
|
+
- [SwaggyJenkinsClient::PipelinelatestRunartifacts](docs/PipelinelatestRunartifacts.md)
|
227
|
+
- [SwaggyJenkinsClient::Pipelines](docs/Pipelines.md)
|
228
|
+
- [SwaggyJenkinsClient::Queue](docs/Queue.md)
|
229
|
+
- [SwaggyJenkinsClient::QueueBlockedItem](docs/QueueBlockedItem.md)
|
230
|
+
- [SwaggyJenkinsClient::QueueItemImpl](docs/QueueItemImpl.md)
|
231
|
+
- [SwaggyJenkinsClient::QueueLeftItem](docs/QueueLeftItem.md)
|
232
|
+
- [SwaggyJenkinsClient::ResponseTimeMonitorData](docs/ResponseTimeMonitorData.md)
|
233
|
+
- [SwaggyJenkinsClient::ScmOrganisations](docs/ScmOrganisations.md)
|
234
|
+
- [SwaggyJenkinsClient::StringParameterDefinition](docs/StringParameterDefinition.md)
|
235
|
+
- [SwaggyJenkinsClient::StringParameterValue](docs/StringParameterValue.md)
|
236
|
+
- [SwaggyJenkinsClient::SwapSpaceMonitorMemoryUsage2](docs/SwapSpaceMonitorMemoryUsage2.md)
|
237
|
+
- [SwaggyJenkinsClient::UnlabeledLoadStatistics](docs/UnlabeledLoadStatistics.md)
|
238
|
+
- [SwaggyJenkinsClient::User](docs/User.md)
|
239
|
+
- [SwaggyJenkinsClient::UserFavorites](docs/UserFavorites.md)
|
240
|
+
- [SwaggyJenkinsClient::Users](docs/Users.md)
|
241
|
+
|
242
|
+
|
243
|
+
## Documentation for Authorization
|
244
|
+
|
245
|
+
|
246
|
+
### jenkins_auth
|
247
|
+
|
248
|
+
- **Type**: HTTP basic authentication
|
249
|
+
|
data/Rakefile
ADDED
data/docs/AllView.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggyJenkinsClient::AllView
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**url** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,2034 @@
|
|
1
|
+
# SwaggyJenkinsClient::BlueOceanApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_pipeline_queue_item**](BlueOceanApi.md#delete_pipeline_queue_item) | **DELETE** /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue/{queue} |
|
8
|
+
[**get_authenticated_user**](BlueOceanApi.md#get_authenticated_user) | **GET** /blue/rest/organizations/{organization}/user/ |
|
9
|
+
[**get_classes**](BlueOceanApi.md#get_classes) | **GET** /blue/rest/classes/{class} |
|
10
|
+
[**get_organisation**](BlueOceanApi.md#get_organisation) | **GET** /blue/rest/organizations/{organization} |
|
11
|
+
[**get_organisations**](BlueOceanApi.md#get_organisations) | **GET** /blue/rest/organizations/ |
|
12
|
+
[**get_pipeline**](BlueOceanApi.md#get_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline} |
|
13
|
+
[**get_pipeline_activities**](BlueOceanApi.md#get_pipeline_activities) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/activities |
|
14
|
+
[**get_pipeline_branch**](BlueOceanApi.md#get_pipeline_branch) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/ |
|
15
|
+
[**get_pipeline_branch_run**](BlueOceanApi.md#get_pipeline_branch_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run} |
|
16
|
+
[**get_pipeline_branches**](BlueOceanApi.md#get_pipeline_branches) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches |
|
17
|
+
[**get_pipeline_folder**](BlueOceanApi.md#get_pipeline_folder) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/ |
|
18
|
+
[**get_pipeline_folder_pipeline**](BlueOceanApi.md#get_pipeline_folder_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline} |
|
19
|
+
[**get_pipeline_queue**](BlueOceanApi.md#get_pipeline_queue) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue |
|
20
|
+
[**get_pipeline_run**](BlueOceanApi.md#get_pipeline_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run} |
|
21
|
+
[**get_pipeline_run_log**](BlueOceanApi.md#get_pipeline_run_log) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log |
|
22
|
+
[**get_pipeline_run_node**](BlueOceanApi.md#get_pipeline_run_node) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node} |
|
23
|
+
[**get_pipeline_run_node_step**](BlueOceanApi.md#get_pipeline_run_node_step) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step} |
|
24
|
+
[**get_pipeline_run_node_step_log**](BlueOceanApi.md#get_pipeline_run_node_step_log) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log |
|
25
|
+
[**get_pipeline_run_node_steps**](BlueOceanApi.md#get_pipeline_run_node_steps) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps |
|
26
|
+
[**get_pipeline_run_nodes**](BlueOceanApi.md#get_pipeline_run_nodes) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes |
|
27
|
+
[**get_pipeline_runs**](BlueOceanApi.md#get_pipeline_runs) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs |
|
28
|
+
[**get_pipelines**](BlueOceanApi.md#get_pipelines) | **GET** /blue/rest/organizations/{organization}/pipelines/ |
|
29
|
+
[**get_scm**](BlueOceanApi.md#get_scm) | **GET** /blue/rest/organizations/{organization}/scm/{scm} |
|
30
|
+
[**get_scm_organisation_repositories**](BlueOceanApi.md#get_scm_organisation_repositories) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories |
|
31
|
+
[**get_scm_organisation_repository**](BlueOceanApi.md#get_scm_organisation_repository) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository} |
|
32
|
+
[**get_scm_organisations**](BlueOceanApi.md#get_scm_organisations) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations |
|
33
|
+
[**get_user**](BlueOceanApi.md#get_user) | **GET** /blue/rest/organizations/{organization}/users/{user} |
|
34
|
+
[**get_user_favorites**](BlueOceanApi.md#get_user_favorites) | **GET** /blue/rest/users/{user}/favorites |
|
35
|
+
[**get_users**](BlueOceanApi.md#get_users) | **GET** /blue/rest/organizations/{organization}/users/ |
|
36
|
+
[**post_pipeline_run**](BlueOceanApi.md#post_pipeline_run) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay |
|
37
|
+
[**post_pipeline_runs**](BlueOceanApi.md#post_pipeline_runs) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs |
|
38
|
+
[**put_pipeline_favorite**](BlueOceanApi.md#put_pipeline_favorite) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite |
|
39
|
+
[**put_pipeline_run**](BlueOceanApi.md#put_pipeline_run) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop |
|
40
|
+
[**search**](BlueOceanApi.md#search) | **GET** /blue/rest/search/ |
|
41
|
+
[**search_classes**](BlueOceanApi.md#search_classes) | **GET** /blue/rest/classes/ |
|
42
|
+
|
43
|
+
|
44
|
+
# **delete_pipeline_queue_item**
|
45
|
+
> delete_pipeline_queue_item(organization, pipeline, queue)
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
Delete queue item from an organization pipeline queue
|
50
|
+
|
51
|
+
### Example
|
52
|
+
```ruby
|
53
|
+
# load the gem
|
54
|
+
require 'swaggy_jenkins'
|
55
|
+
# setup authorization
|
56
|
+
SwaggyJenkinsClient.configure do |config|
|
57
|
+
# Configure HTTP basic authorization: jenkins_auth
|
58
|
+
config.username = 'YOUR USERNAME'
|
59
|
+
config.password = 'YOUR PASSWORD'
|
60
|
+
end
|
61
|
+
|
62
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
63
|
+
|
64
|
+
organization = "organization_example" # String | Name of the organization
|
65
|
+
|
66
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
67
|
+
|
68
|
+
queue = "queue_example" # String | Name of the queue item
|
69
|
+
|
70
|
+
|
71
|
+
begin
|
72
|
+
api_instance.delete_pipeline_queue_item(organization, pipeline, queue)
|
73
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
74
|
+
puts "Exception when calling BlueOceanApi->delete_pipeline_queue_item: #{e}"
|
75
|
+
end
|
76
|
+
```
|
77
|
+
|
78
|
+
### Parameters
|
79
|
+
|
80
|
+
Name | Type | Description | Notes
|
81
|
+
------------- | ------------- | ------------- | -------------
|
82
|
+
**organization** | **String**| Name of the organization |
|
83
|
+
**pipeline** | **String**| Name of the pipeline |
|
84
|
+
**queue** | **String**| Name of the queue item |
|
85
|
+
|
86
|
+
### Return type
|
87
|
+
|
88
|
+
nil (empty response body)
|
89
|
+
|
90
|
+
### Authorization
|
91
|
+
|
92
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
93
|
+
|
94
|
+
### HTTP request headers
|
95
|
+
|
96
|
+
- **Content-Type**: Not defined
|
97
|
+
- **Accept**: application/json
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
# **get_authenticated_user**
|
102
|
+
> User get_authenticated_user(organization, )
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
Retrieve authenticated user details for an organization
|
107
|
+
|
108
|
+
### Example
|
109
|
+
```ruby
|
110
|
+
# load the gem
|
111
|
+
require 'swaggy_jenkins'
|
112
|
+
# setup authorization
|
113
|
+
SwaggyJenkinsClient.configure do |config|
|
114
|
+
# Configure HTTP basic authorization: jenkins_auth
|
115
|
+
config.username = 'YOUR USERNAME'
|
116
|
+
config.password = 'YOUR PASSWORD'
|
117
|
+
end
|
118
|
+
|
119
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
120
|
+
|
121
|
+
organization = "organization_example" # String | Name of the organization
|
122
|
+
|
123
|
+
|
124
|
+
begin
|
125
|
+
result = api_instance.get_authenticated_user(organization, )
|
126
|
+
p result
|
127
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
128
|
+
puts "Exception when calling BlueOceanApi->get_authenticated_user: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**organization** | **String**| Name of the organization |
|
137
|
+
|
138
|
+
### Return type
|
139
|
+
|
140
|
+
[**User**](User.md)
|
141
|
+
|
142
|
+
### Authorization
|
143
|
+
|
144
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
145
|
+
|
146
|
+
### HTTP request headers
|
147
|
+
|
148
|
+
- **Content-Type**: Not defined
|
149
|
+
- **Accept**: application/json
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
# **get_classes**
|
154
|
+
> String get_classes(_class)
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
Get a list of class names supported by a given class
|
159
|
+
|
160
|
+
### Example
|
161
|
+
```ruby
|
162
|
+
# load the gem
|
163
|
+
require 'swaggy_jenkins'
|
164
|
+
# setup authorization
|
165
|
+
SwaggyJenkinsClient.configure do |config|
|
166
|
+
# Configure HTTP basic authorization: jenkins_auth
|
167
|
+
config.username = 'YOUR USERNAME'
|
168
|
+
config.password = 'YOUR PASSWORD'
|
169
|
+
end
|
170
|
+
|
171
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
172
|
+
|
173
|
+
_class = "_class_example" # String | Name of the class
|
174
|
+
|
175
|
+
|
176
|
+
begin
|
177
|
+
result = api_instance.get_classes(_class)
|
178
|
+
p result
|
179
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
180
|
+
puts "Exception when calling BlueOceanApi->get_classes: #{e}"
|
181
|
+
end
|
182
|
+
```
|
183
|
+
|
184
|
+
### Parameters
|
185
|
+
|
186
|
+
Name | Type | Description | Notes
|
187
|
+
------------- | ------------- | ------------- | -------------
|
188
|
+
**_class** | **String**| Name of the class |
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
**String**
|
193
|
+
|
194
|
+
### Authorization
|
195
|
+
|
196
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
197
|
+
|
198
|
+
### HTTP request headers
|
199
|
+
|
200
|
+
- **Content-Type**: Not defined
|
201
|
+
- **Accept**: application/json
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
# **get_organisation**
|
206
|
+
> Organisation get_organisation(organization, )
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
Retrieve organization details
|
211
|
+
|
212
|
+
### Example
|
213
|
+
```ruby
|
214
|
+
# load the gem
|
215
|
+
require 'swaggy_jenkins'
|
216
|
+
# setup authorization
|
217
|
+
SwaggyJenkinsClient.configure do |config|
|
218
|
+
# Configure HTTP basic authorization: jenkins_auth
|
219
|
+
config.username = 'YOUR USERNAME'
|
220
|
+
config.password = 'YOUR PASSWORD'
|
221
|
+
end
|
222
|
+
|
223
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
224
|
+
|
225
|
+
organization = "organization_example" # String | Name of the organization
|
226
|
+
|
227
|
+
|
228
|
+
begin
|
229
|
+
result = api_instance.get_organisation(organization, )
|
230
|
+
p result
|
231
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
232
|
+
puts "Exception when calling BlueOceanApi->get_organisation: #{e}"
|
233
|
+
end
|
234
|
+
```
|
235
|
+
|
236
|
+
### Parameters
|
237
|
+
|
238
|
+
Name | Type | Description | Notes
|
239
|
+
------------- | ------------- | ------------- | -------------
|
240
|
+
**organization** | **String**| Name of the organization |
|
241
|
+
|
242
|
+
### Return type
|
243
|
+
|
244
|
+
[**Organisation**](Organisation.md)
|
245
|
+
|
246
|
+
### Authorization
|
247
|
+
|
248
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: application/json
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
# **get_organisations**
|
258
|
+
> Organisations get_organisations
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
Retrieve all organizations details
|
263
|
+
|
264
|
+
### Example
|
265
|
+
```ruby
|
266
|
+
# load the gem
|
267
|
+
require 'swaggy_jenkins'
|
268
|
+
# setup authorization
|
269
|
+
SwaggyJenkinsClient.configure do |config|
|
270
|
+
# Configure HTTP basic authorization: jenkins_auth
|
271
|
+
config.username = 'YOUR USERNAME'
|
272
|
+
config.password = 'YOUR PASSWORD'
|
273
|
+
end
|
274
|
+
|
275
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
276
|
+
|
277
|
+
begin
|
278
|
+
result = api_instance.get_organisations
|
279
|
+
p result
|
280
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
281
|
+
puts "Exception when calling BlueOceanApi->get_organisations: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
### Parameters
|
286
|
+
This endpoint does not need any parameter.
|
287
|
+
|
288
|
+
### Return type
|
289
|
+
|
290
|
+
[**Organisations**](Organisations.md)
|
291
|
+
|
292
|
+
### Authorization
|
293
|
+
|
294
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
295
|
+
|
296
|
+
### HTTP request headers
|
297
|
+
|
298
|
+
- **Content-Type**: Not defined
|
299
|
+
- **Accept**: application/json
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
# **get_pipeline**
|
304
|
+
> Pipeline get_pipeline(organization, pipeline, )
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
Retrieve pipeline details for an organization
|
309
|
+
|
310
|
+
### Example
|
311
|
+
```ruby
|
312
|
+
# load the gem
|
313
|
+
require 'swaggy_jenkins'
|
314
|
+
# setup authorization
|
315
|
+
SwaggyJenkinsClient.configure do |config|
|
316
|
+
# Configure HTTP basic authorization: jenkins_auth
|
317
|
+
config.username = 'YOUR USERNAME'
|
318
|
+
config.password = 'YOUR PASSWORD'
|
319
|
+
end
|
320
|
+
|
321
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
322
|
+
|
323
|
+
organization = "organization_example" # String | Name of the organization
|
324
|
+
|
325
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
326
|
+
|
327
|
+
|
328
|
+
begin
|
329
|
+
result = api_instance.get_pipeline(organization, pipeline, )
|
330
|
+
p result
|
331
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
332
|
+
puts "Exception when calling BlueOceanApi->get_pipeline: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### Parameters
|
337
|
+
|
338
|
+
Name | Type | Description | Notes
|
339
|
+
------------- | ------------- | ------------- | -------------
|
340
|
+
**organization** | **String**| Name of the organization |
|
341
|
+
**pipeline** | **String**| Name of the pipeline |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
[**Pipeline**](Pipeline.md)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: application/json
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
# **get_pipeline_activities**
|
359
|
+
> PipelineActivities get_pipeline_activities(organization, pipeline, )
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
Retrieve all activities details for an organization pipeline
|
364
|
+
|
365
|
+
### Example
|
366
|
+
```ruby
|
367
|
+
# load the gem
|
368
|
+
require 'swaggy_jenkins'
|
369
|
+
# setup authorization
|
370
|
+
SwaggyJenkinsClient.configure do |config|
|
371
|
+
# Configure HTTP basic authorization: jenkins_auth
|
372
|
+
config.username = 'YOUR USERNAME'
|
373
|
+
config.password = 'YOUR PASSWORD'
|
374
|
+
end
|
375
|
+
|
376
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
377
|
+
|
378
|
+
organization = "organization_example" # String | Name of the organization
|
379
|
+
|
380
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
381
|
+
|
382
|
+
|
383
|
+
begin
|
384
|
+
result = api_instance.get_pipeline_activities(organization, pipeline, )
|
385
|
+
p result
|
386
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
387
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_activities: #{e}"
|
388
|
+
end
|
389
|
+
```
|
390
|
+
|
391
|
+
### Parameters
|
392
|
+
|
393
|
+
Name | Type | Description | Notes
|
394
|
+
------------- | ------------- | ------------- | -------------
|
395
|
+
**organization** | **String**| Name of the organization |
|
396
|
+
**pipeline** | **String**| Name of the pipeline |
|
397
|
+
|
398
|
+
### Return type
|
399
|
+
|
400
|
+
[**PipelineActivities**](PipelineActivities.md)
|
401
|
+
|
402
|
+
### Authorization
|
403
|
+
|
404
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
405
|
+
|
406
|
+
### HTTP request headers
|
407
|
+
|
408
|
+
- **Content-Type**: Not defined
|
409
|
+
- **Accept**: application/json
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
# **get_pipeline_branch**
|
414
|
+
> BranchImpl get_pipeline_branch(organization, pipeline, branch, )
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
Retrieve branch details for an organization pipeline
|
419
|
+
|
420
|
+
### Example
|
421
|
+
```ruby
|
422
|
+
# load the gem
|
423
|
+
require 'swaggy_jenkins'
|
424
|
+
# setup authorization
|
425
|
+
SwaggyJenkinsClient.configure do |config|
|
426
|
+
# Configure HTTP basic authorization: jenkins_auth
|
427
|
+
config.username = 'YOUR USERNAME'
|
428
|
+
config.password = 'YOUR PASSWORD'
|
429
|
+
end
|
430
|
+
|
431
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
432
|
+
|
433
|
+
organization = "organization_example" # String | Name of the organization
|
434
|
+
|
435
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
436
|
+
|
437
|
+
branch = "branch_example" # String | Name of the branch
|
438
|
+
|
439
|
+
|
440
|
+
begin
|
441
|
+
result = api_instance.get_pipeline_branch(organization, pipeline, branch, )
|
442
|
+
p result
|
443
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
444
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_branch: #{e}"
|
445
|
+
end
|
446
|
+
```
|
447
|
+
|
448
|
+
### Parameters
|
449
|
+
|
450
|
+
Name | Type | Description | Notes
|
451
|
+
------------- | ------------- | ------------- | -------------
|
452
|
+
**organization** | **String**| Name of the organization |
|
453
|
+
**pipeline** | **String**| Name of the pipeline |
|
454
|
+
**branch** | **String**| Name of the branch |
|
455
|
+
|
456
|
+
### Return type
|
457
|
+
|
458
|
+
[**BranchImpl**](BranchImpl.md)
|
459
|
+
|
460
|
+
### Authorization
|
461
|
+
|
462
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
463
|
+
|
464
|
+
### HTTP request headers
|
465
|
+
|
466
|
+
- **Content-Type**: Not defined
|
467
|
+
- **Accept**: application/json
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
# **get_pipeline_branch_run**
|
472
|
+
> PipelineRun get_pipeline_branch_run(organization, pipeline, branch, run)
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
Retrieve branch run details for an organization pipeline
|
477
|
+
|
478
|
+
### Example
|
479
|
+
```ruby
|
480
|
+
# load the gem
|
481
|
+
require 'swaggy_jenkins'
|
482
|
+
# setup authorization
|
483
|
+
SwaggyJenkinsClient.configure do |config|
|
484
|
+
# Configure HTTP basic authorization: jenkins_auth
|
485
|
+
config.username = 'YOUR USERNAME'
|
486
|
+
config.password = 'YOUR PASSWORD'
|
487
|
+
end
|
488
|
+
|
489
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
490
|
+
|
491
|
+
organization = "organization_example" # String | Name of the organization
|
492
|
+
|
493
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
494
|
+
|
495
|
+
branch = "branch_example" # String | Name of the branch
|
496
|
+
|
497
|
+
run = "run_example" # String | Name of the run
|
498
|
+
|
499
|
+
|
500
|
+
begin
|
501
|
+
result = api_instance.get_pipeline_branch_run(organization, pipeline, branch, run)
|
502
|
+
p result
|
503
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
504
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_branch_run: #{e}"
|
505
|
+
end
|
506
|
+
```
|
507
|
+
|
508
|
+
### Parameters
|
509
|
+
|
510
|
+
Name | Type | Description | Notes
|
511
|
+
------------- | ------------- | ------------- | -------------
|
512
|
+
**organization** | **String**| Name of the organization |
|
513
|
+
**pipeline** | **String**| Name of the pipeline |
|
514
|
+
**branch** | **String**| Name of the branch |
|
515
|
+
**run** | **String**| Name of the run |
|
516
|
+
|
517
|
+
### Return type
|
518
|
+
|
519
|
+
[**PipelineRun**](PipelineRun.md)
|
520
|
+
|
521
|
+
### Authorization
|
522
|
+
|
523
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
524
|
+
|
525
|
+
### HTTP request headers
|
526
|
+
|
527
|
+
- **Content-Type**: Not defined
|
528
|
+
- **Accept**: application/json
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
# **get_pipeline_branches**
|
533
|
+
> MultibranchPipeline get_pipeline_branches(organization, pipeline, )
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
Retrieve all branches details for an organization pipeline
|
538
|
+
|
539
|
+
### Example
|
540
|
+
```ruby
|
541
|
+
# load the gem
|
542
|
+
require 'swaggy_jenkins'
|
543
|
+
# setup authorization
|
544
|
+
SwaggyJenkinsClient.configure do |config|
|
545
|
+
# Configure HTTP basic authorization: jenkins_auth
|
546
|
+
config.username = 'YOUR USERNAME'
|
547
|
+
config.password = 'YOUR PASSWORD'
|
548
|
+
end
|
549
|
+
|
550
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
551
|
+
|
552
|
+
organization = "organization_example" # String | Name of the organization
|
553
|
+
|
554
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
555
|
+
|
556
|
+
|
557
|
+
begin
|
558
|
+
result = api_instance.get_pipeline_branches(organization, pipeline, )
|
559
|
+
p result
|
560
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
561
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_branches: #{e}"
|
562
|
+
end
|
563
|
+
```
|
564
|
+
|
565
|
+
### Parameters
|
566
|
+
|
567
|
+
Name | Type | Description | Notes
|
568
|
+
------------- | ------------- | ------------- | -------------
|
569
|
+
**organization** | **String**| Name of the organization |
|
570
|
+
**pipeline** | **String**| Name of the pipeline |
|
571
|
+
|
572
|
+
### Return type
|
573
|
+
|
574
|
+
[**MultibranchPipeline**](MultibranchPipeline.md)
|
575
|
+
|
576
|
+
### Authorization
|
577
|
+
|
578
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
579
|
+
|
580
|
+
### HTTP request headers
|
581
|
+
|
582
|
+
- **Content-Type**: Not defined
|
583
|
+
- **Accept**: application/json
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
# **get_pipeline_folder**
|
588
|
+
> PipelineFolderImpl get_pipeline_folder(organization, folder)
|
589
|
+
|
590
|
+
|
591
|
+
|
592
|
+
Retrieve pipeline folder for an organization
|
593
|
+
|
594
|
+
### Example
|
595
|
+
```ruby
|
596
|
+
# load the gem
|
597
|
+
require 'swaggy_jenkins'
|
598
|
+
# setup authorization
|
599
|
+
SwaggyJenkinsClient.configure do |config|
|
600
|
+
# Configure HTTP basic authorization: jenkins_auth
|
601
|
+
config.username = 'YOUR USERNAME'
|
602
|
+
config.password = 'YOUR PASSWORD'
|
603
|
+
end
|
604
|
+
|
605
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
606
|
+
|
607
|
+
organization = "organization_example" # String | Name of the organization
|
608
|
+
|
609
|
+
folder = "folder_example" # String | Name of the folder
|
610
|
+
|
611
|
+
|
612
|
+
begin
|
613
|
+
result = api_instance.get_pipeline_folder(organization, folder)
|
614
|
+
p result
|
615
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
616
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_folder: #{e}"
|
617
|
+
end
|
618
|
+
```
|
619
|
+
|
620
|
+
### Parameters
|
621
|
+
|
622
|
+
Name | Type | Description | Notes
|
623
|
+
------------- | ------------- | ------------- | -------------
|
624
|
+
**organization** | **String**| Name of the organization |
|
625
|
+
**folder** | **String**| Name of the folder |
|
626
|
+
|
627
|
+
### Return type
|
628
|
+
|
629
|
+
[**PipelineFolderImpl**](PipelineFolderImpl.md)
|
630
|
+
|
631
|
+
### Authorization
|
632
|
+
|
633
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
634
|
+
|
635
|
+
### HTTP request headers
|
636
|
+
|
637
|
+
- **Content-Type**: Not defined
|
638
|
+
- **Accept**: application/json
|
639
|
+
|
640
|
+
|
641
|
+
|
642
|
+
# **get_pipeline_folder_pipeline**
|
643
|
+
> PipelineImpl get_pipeline_folder_pipeline(organization, pipeline, folder)
|
644
|
+
|
645
|
+
|
646
|
+
|
647
|
+
Retrieve pipeline details for an organization folder
|
648
|
+
|
649
|
+
### Example
|
650
|
+
```ruby
|
651
|
+
# load the gem
|
652
|
+
require 'swaggy_jenkins'
|
653
|
+
# setup authorization
|
654
|
+
SwaggyJenkinsClient.configure do |config|
|
655
|
+
# Configure HTTP basic authorization: jenkins_auth
|
656
|
+
config.username = 'YOUR USERNAME'
|
657
|
+
config.password = 'YOUR PASSWORD'
|
658
|
+
end
|
659
|
+
|
660
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
661
|
+
|
662
|
+
organization = "organization_example" # String | Name of the organization
|
663
|
+
|
664
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
665
|
+
|
666
|
+
folder = "folder_example" # String | Name of the folder
|
667
|
+
|
668
|
+
|
669
|
+
begin
|
670
|
+
result = api_instance.get_pipeline_folder_pipeline(organization, pipeline, folder)
|
671
|
+
p result
|
672
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
673
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_folder_pipeline: #{e}"
|
674
|
+
end
|
675
|
+
```
|
676
|
+
|
677
|
+
### Parameters
|
678
|
+
|
679
|
+
Name | Type | Description | Notes
|
680
|
+
------------- | ------------- | ------------- | -------------
|
681
|
+
**organization** | **String**| Name of the organization |
|
682
|
+
**pipeline** | **String**| Name of the pipeline |
|
683
|
+
**folder** | **String**| Name of the folder |
|
684
|
+
|
685
|
+
### Return type
|
686
|
+
|
687
|
+
[**PipelineImpl**](PipelineImpl.md)
|
688
|
+
|
689
|
+
### Authorization
|
690
|
+
|
691
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
692
|
+
|
693
|
+
### HTTP request headers
|
694
|
+
|
695
|
+
- **Content-Type**: Not defined
|
696
|
+
- **Accept**: application/json
|
697
|
+
|
698
|
+
|
699
|
+
|
700
|
+
# **get_pipeline_queue**
|
701
|
+
> PipelineQueue get_pipeline_queue(organization, pipeline, )
|
702
|
+
|
703
|
+
|
704
|
+
|
705
|
+
Retrieve queue details for an organization pipeline
|
706
|
+
|
707
|
+
### Example
|
708
|
+
```ruby
|
709
|
+
# load the gem
|
710
|
+
require 'swaggy_jenkins'
|
711
|
+
# setup authorization
|
712
|
+
SwaggyJenkinsClient.configure do |config|
|
713
|
+
# Configure HTTP basic authorization: jenkins_auth
|
714
|
+
config.username = 'YOUR USERNAME'
|
715
|
+
config.password = 'YOUR PASSWORD'
|
716
|
+
end
|
717
|
+
|
718
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
719
|
+
|
720
|
+
organization = "organization_example" # String | Name of the organization
|
721
|
+
|
722
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
723
|
+
|
724
|
+
|
725
|
+
begin
|
726
|
+
result = api_instance.get_pipeline_queue(organization, pipeline, )
|
727
|
+
p result
|
728
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
729
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_queue: #{e}"
|
730
|
+
end
|
731
|
+
```
|
732
|
+
|
733
|
+
### Parameters
|
734
|
+
|
735
|
+
Name | Type | Description | Notes
|
736
|
+
------------- | ------------- | ------------- | -------------
|
737
|
+
**organization** | **String**| Name of the organization |
|
738
|
+
**pipeline** | **String**| Name of the pipeline |
|
739
|
+
|
740
|
+
### Return type
|
741
|
+
|
742
|
+
[**PipelineQueue**](PipelineQueue.md)
|
743
|
+
|
744
|
+
### Authorization
|
745
|
+
|
746
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
747
|
+
|
748
|
+
### HTTP request headers
|
749
|
+
|
750
|
+
- **Content-Type**: Not defined
|
751
|
+
- **Accept**: application/json
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
# **get_pipeline_run**
|
756
|
+
> PipelineRun get_pipeline_run(organization, pipeline, run)
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
Retrieve run details for an organization pipeline
|
761
|
+
|
762
|
+
### Example
|
763
|
+
```ruby
|
764
|
+
# load the gem
|
765
|
+
require 'swaggy_jenkins'
|
766
|
+
# setup authorization
|
767
|
+
SwaggyJenkinsClient.configure do |config|
|
768
|
+
# Configure HTTP basic authorization: jenkins_auth
|
769
|
+
config.username = 'YOUR USERNAME'
|
770
|
+
config.password = 'YOUR PASSWORD'
|
771
|
+
end
|
772
|
+
|
773
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
774
|
+
|
775
|
+
organization = "organization_example" # String | Name of the organization
|
776
|
+
|
777
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
778
|
+
|
779
|
+
run = "run_example" # String | Name of the run
|
780
|
+
|
781
|
+
|
782
|
+
begin
|
783
|
+
result = api_instance.get_pipeline_run(organization, pipeline, run)
|
784
|
+
p result
|
785
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
786
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run: #{e}"
|
787
|
+
end
|
788
|
+
```
|
789
|
+
|
790
|
+
### Parameters
|
791
|
+
|
792
|
+
Name | Type | Description | Notes
|
793
|
+
------------- | ------------- | ------------- | -------------
|
794
|
+
**organization** | **String**| Name of the organization |
|
795
|
+
**pipeline** | **String**| Name of the pipeline |
|
796
|
+
**run** | **String**| Name of the run |
|
797
|
+
|
798
|
+
### Return type
|
799
|
+
|
800
|
+
[**PipelineRun**](PipelineRun.md)
|
801
|
+
|
802
|
+
### Authorization
|
803
|
+
|
804
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
805
|
+
|
806
|
+
### HTTP request headers
|
807
|
+
|
808
|
+
- **Content-Type**: Not defined
|
809
|
+
- **Accept**: application/json
|
810
|
+
|
811
|
+
|
812
|
+
|
813
|
+
# **get_pipeline_run_log**
|
814
|
+
> String get_pipeline_run_log(organization, pipeline, run, opts)
|
815
|
+
|
816
|
+
|
817
|
+
|
818
|
+
Get log for a pipeline run
|
819
|
+
|
820
|
+
### Example
|
821
|
+
```ruby
|
822
|
+
# load the gem
|
823
|
+
require 'swaggy_jenkins'
|
824
|
+
# setup authorization
|
825
|
+
SwaggyJenkinsClient.configure do |config|
|
826
|
+
# Configure HTTP basic authorization: jenkins_auth
|
827
|
+
config.username = 'YOUR USERNAME'
|
828
|
+
config.password = 'YOUR PASSWORD'
|
829
|
+
end
|
830
|
+
|
831
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
832
|
+
|
833
|
+
organization = "organization_example" # String | Name of the organization
|
834
|
+
|
835
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
836
|
+
|
837
|
+
run = "run_example" # String | Name of the run
|
838
|
+
|
839
|
+
opts = {
|
840
|
+
start: 56, # Integer | Start position of the log
|
841
|
+
download: true # BOOLEAN | Set to true in order to download the file, otherwise it's passed as a response body
|
842
|
+
}
|
843
|
+
|
844
|
+
begin
|
845
|
+
result = api_instance.get_pipeline_run_log(organization, pipeline, run, opts)
|
846
|
+
p result
|
847
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
848
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_log: #{e}"
|
849
|
+
end
|
850
|
+
```
|
851
|
+
|
852
|
+
### Parameters
|
853
|
+
|
854
|
+
Name | Type | Description | Notes
|
855
|
+
------------- | ------------- | ------------- | -------------
|
856
|
+
**organization** | **String**| Name of the organization |
|
857
|
+
**pipeline** | **String**| Name of the pipeline |
|
858
|
+
**run** | **String**| Name of the run |
|
859
|
+
**start** | **Integer**| Start position of the log | [optional]
|
860
|
+
**download** | **BOOLEAN**| Set to true in order to download the file, otherwise it's passed as a response body | [optional]
|
861
|
+
|
862
|
+
### Return type
|
863
|
+
|
864
|
+
**String**
|
865
|
+
|
866
|
+
### Authorization
|
867
|
+
|
868
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
869
|
+
|
870
|
+
### HTTP request headers
|
871
|
+
|
872
|
+
- **Content-Type**: Not defined
|
873
|
+
- **Accept**: application/json
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
# **get_pipeline_run_node**
|
878
|
+
> PipelineRunNode get_pipeline_run_node(organization, pipeline, runnode, )
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
Retrieve run node details for an organization pipeline
|
883
|
+
|
884
|
+
### Example
|
885
|
+
```ruby
|
886
|
+
# load the gem
|
887
|
+
require 'swaggy_jenkins'
|
888
|
+
# setup authorization
|
889
|
+
SwaggyJenkinsClient.configure do |config|
|
890
|
+
# Configure HTTP basic authorization: jenkins_auth
|
891
|
+
config.username = 'YOUR USERNAME'
|
892
|
+
config.password = 'YOUR PASSWORD'
|
893
|
+
end
|
894
|
+
|
895
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
896
|
+
|
897
|
+
organization = "organization_example" # String | Name of the organization
|
898
|
+
|
899
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
900
|
+
|
901
|
+
run = "run_example" # String | Name of the run
|
902
|
+
|
903
|
+
node = "node_example" # String | Name of the node
|
904
|
+
|
905
|
+
|
906
|
+
begin
|
907
|
+
result = api_instance.get_pipeline_run_node(organization, pipeline, runnode, )
|
908
|
+
p result
|
909
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
910
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_node: #{e}"
|
911
|
+
end
|
912
|
+
```
|
913
|
+
|
914
|
+
### Parameters
|
915
|
+
|
916
|
+
Name | Type | Description | Notes
|
917
|
+
------------- | ------------- | ------------- | -------------
|
918
|
+
**organization** | **String**| Name of the organization |
|
919
|
+
**pipeline** | **String**| Name of the pipeline |
|
920
|
+
**run** | **String**| Name of the run |
|
921
|
+
**node** | **String**| Name of the node |
|
922
|
+
|
923
|
+
### Return type
|
924
|
+
|
925
|
+
[**PipelineRunNode**](PipelineRunNode.md)
|
926
|
+
|
927
|
+
### Authorization
|
928
|
+
|
929
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
930
|
+
|
931
|
+
### HTTP request headers
|
932
|
+
|
933
|
+
- **Content-Type**: Not defined
|
934
|
+
- **Accept**: application/json
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
# **get_pipeline_run_node_step**
|
939
|
+
> PipelineStepImpl get_pipeline_run_node_step(organization, pipeline, runnode, step)
|
940
|
+
|
941
|
+
|
942
|
+
|
943
|
+
Retrieve run node details for an organization pipeline
|
944
|
+
|
945
|
+
### Example
|
946
|
+
```ruby
|
947
|
+
# load the gem
|
948
|
+
require 'swaggy_jenkins'
|
949
|
+
# setup authorization
|
950
|
+
SwaggyJenkinsClient.configure do |config|
|
951
|
+
# Configure HTTP basic authorization: jenkins_auth
|
952
|
+
config.username = 'YOUR USERNAME'
|
953
|
+
config.password = 'YOUR PASSWORD'
|
954
|
+
end
|
955
|
+
|
956
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
957
|
+
|
958
|
+
organization = "organization_example" # String | Name of the organization
|
959
|
+
|
960
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
961
|
+
|
962
|
+
run = "run_example" # String | Name of the run
|
963
|
+
|
964
|
+
node = "node_example" # String | Name of the node
|
965
|
+
|
966
|
+
step = "step_example" # String | Name of the step
|
967
|
+
|
968
|
+
|
969
|
+
begin
|
970
|
+
result = api_instance.get_pipeline_run_node_step(organization, pipeline, runnode, step)
|
971
|
+
p result
|
972
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
973
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_node_step: #{e}"
|
974
|
+
end
|
975
|
+
```
|
976
|
+
|
977
|
+
### Parameters
|
978
|
+
|
979
|
+
Name | Type | Description | Notes
|
980
|
+
------------- | ------------- | ------------- | -------------
|
981
|
+
**organization** | **String**| Name of the organization |
|
982
|
+
**pipeline** | **String**| Name of the pipeline |
|
983
|
+
**run** | **String**| Name of the run |
|
984
|
+
**node** | **String**| Name of the node |
|
985
|
+
**step** | **String**| Name of the step |
|
986
|
+
|
987
|
+
### Return type
|
988
|
+
|
989
|
+
[**PipelineStepImpl**](PipelineStepImpl.md)
|
990
|
+
|
991
|
+
### Authorization
|
992
|
+
|
993
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
994
|
+
|
995
|
+
### HTTP request headers
|
996
|
+
|
997
|
+
- **Content-Type**: Not defined
|
998
|
+
- **Accept**: application/json
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
# **get_pipeline_run_node_step_log**
|
1003
|
+
> String get_pipeline_run_node_step_log(organization, pipeline, runnode, step)
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
Get log for a pipeline run node step
|
1008
|
+
|
1009
|
+
### Example
|
1010
|
+
```ruby
|
1011
|
+
# load the gem
|
1012
|
+
require 'swaggy_jenkins'
|
1013
|
+
# setup authorization
|
1014
|
+
SwaggyJenkinsClient.configure do |config|
|
1015
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1016
|
+
config.username = 'YOUR USERNAME'
|
1017
|
+
config.password = 'YOUR PASSWORD'
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1021
|
+
|
1022
|
+
organization = "organization_example" # String | Name of the organization
|
1023
|
+
|
1024
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1025
|
+
|
1026
|
+
run = "run_example" # String | Name of the run
|
1027
|
+
|
1028
|
+
node = "node_example" # String | Name of the node
|
1029
|
+
|
1030
|
+
step = "step_example" # String | Name of the step
|
1031
|
+
|
1032
|
+
|
1033
|
+
begin
|
1034
|
+
result = api_instance.get_pipeline_run_node_step_log(organization, pipeline, runnode, step)
|
1035
|
+
p result
|
1036
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1037
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_node_step_log: #{e}"
|
1038
|
+
end
|
1039
|
+
```
|
1040
|
+
|
1041
|
+
### Parameters
|
1042
|
+
|
1043
|
+
Name | Type | Description | Notes
|
1044
|
+
------------- | ------------- | ------------- | -------------
|
1045
|
+
**organization** | **String**| Name of the organization |
|
1046
|
+
**pipeline** | **String**| Name of the pipeline |
|
1047
|
+
**run** | **String**| Name of the run |
|
1048
|
+
**node** | **String**| Name of the node |
|
1049
|
+
**step** | **String**| Name of the step |
|
1050
|
+
|
1051
|
+
### Return type
|
1052
|
+
|
1053
|
+
**String**
|
1054
|
+
|
1055
|
+
### Authorization
|
1056
|
+
|
1057
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1058
|
+
|
1059
|
+
### HTTP request headers
|
1060
|
+
|
1061
|
+
- **Content-Type**: Not defined
|
1062
|
+
- **Accept**: application/json
|
1063
|
+
|
1064
|
+
|
1065
|
+
|
1066
|
+
# **get_pipeline_run_node_steps**
|
1067
|
+
> PipelineRunNodeSteps get_pipeline_run_node_steps(organization, pipeline, runnode, )
|
1068
|
+
|
1069
|
+
|
1070
|
+
|
1071
|
+
Retrieve run node steps details for an organization pipeline
|
1072
|
+
|
1073
|
+
### Example
|
1074
|
+
```ruby
|
1075
|
+
# load the gem
|
1076
|
+
require 'swaggy_jenkins'
|
1077
|
+
# setup authorization
|
1078
|
+
SwaggyJenkinsClient.configure do |config|
|
1079
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1080
|
+
config.username = 'YOUR USERNAME'
|
1081
|
+
config.password = 'YOUR PASSWORD'
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1085
|
+
|
1086
|
+
organization = "organization_example" # String | Name of the organization
|
1087
|
+
|
1088
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1089
|
+
|
1090
|
+
run = "run_example" # String | Name of the run
|
1091
|
+
|
1092
|
+
node = "node_example" # String | Name of the node
|
1093
|
+
|
1094
|
+
|
1095
|
+
begin
|
1096
|
+
result = api_instance.get_pipeline_run_node_steps(organization, pipeline, runnode, )
|
1097
|
+
p result
|
1098
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1099
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_node_steps: #{e}"
|
1100
|
+
end
|
1101
|
+
```
|
1102
|
+
|
1103
|
+
### Parameters
|
1104
|
+
|
1105
|
+
Name | Type | Description | Notes
|
1106
|
+
------------- | ------------- | ------------- | -------------
|
1107
|
+
**organization** | **String**| Name of the organization |
|
1108
|
+
**pipeline** | **String**| Name of the pipeline |
|
1109
|
+
**run** | **String**| Name of the run |
|
1110
|
+
**node** | **String**| Name of the node |
|
1111
|
+
|
1112
|
+
### Return type
|
1113
|
+
|
1114
|
+
[**PipelineRunNodeSteps**](PipelineRunNodeSteps.md)
|
1115
|
+
|
1116
|
+
### Authorization
|
1117
|
+
|
1118
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1119
|
+
|
1120
|
+
### HTTP request headers
|
1121
|
+
|
1122
|
+
- **Content-Type**: Not defined
|
1123
|
+
- **Accept**: application/json
|
1124
|
+
|
1125
|
+
|
1126
|
+
|
1127
|
+
# **get_pipeline_run_nodes**
|
1128
|
+
> PipelineRunNodes get_pipeline_run_nodes(organization, pipeline, run)
|
1129
|
+
|
1130
|
+
|
1131
|
+
|
1132
|
+
Retrieve run nodes details for an organization pipeline
|
1133
|
+
|
1134
|
+
### Example
|
1135
|
+
```ruby
|
1136
|
+
# load the gem
|
1137
|
+
require 'swaggy_jenkins'
|
1138
|
+
# setup authorization
|
1139
|
+
SwaggyJenkinsClient.configure do |config|
|
1140
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1141
|
+
config.username = 'YOUR USERNAME'
|
1142
|
+
config.password = 'YOUR PASSWORD'
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1146
|
+
|
1147
|
+
organization = "organization_example" # String | Name of the organization
|
1148
|
+
|
1149
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1150
|
+
|
1151
|
+
run = "run_example" # String | Name of the run
|
1152
|
+
|
1153
|
+
|
1154
|
+
begin
|
1155
|
+
result = api_instance.get_pipeline_run_nodes(organization, pipeline, run)
|
1156
|
+
p result
|
1157
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1158
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_run_nodes: #{e}"
|
1159
|
+
end
|
1160
|
+
```
|
1161
|
+
|
1162
|
+
### Parameters
|
1163
|
+
|
1164
|
+
Name | Type | Description | Notes
|
1165
|
+
------------- | ------------- | ------------- | -------------
|
1166
|
+
**organization** | **String**| Name of the organization |
|
1167
|
+
**pipeline** | **String**| Name of the pipeline |
|
1168
|
+
**run** | **String**| Name of the run |
|
1169
|
+
|
1170
|
+
### Return type
|
1171
|
+
|
1172
|
+
[**PipelineRunNodes**](PipelineRunNodes.md)
|
1173
|
+
|
1174
|
+
### Authorization
|
1175
|
+
|
1176
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1177
|
+
|
1178
|
+
### HTTP request headers
|
1179
|
+
|
1180
|
+
- **Content-Type**: Not defined
|
1181
|
+
- **Accept**: application/json
|
1182
|
+
|
1183
|
+
|
1184
|
+
|
1185
|
+
# **get_pipeline_runs**
|
1186
|
+
> PipelineRuns get_pipeline_runs(organization, pipeline, )
|
1187
|
+
|
1188
|
+
|
1189
|
+
|
1190
|
+
Retrieve all runs details for an organization pipeline
|
1191
|
+
|
1192
|
+
### Example
|
1193
|
+
```ruby
|
1194
|
+
# load the gem
|
1195
|
+
require 'swaggy_jenkins'
|
1196
|
+
# setup authorization
|
1197
|
+
SwaggyJenkinsClient.configure do |config|
|
1198
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1199
|
+
config.username = 'YOUR USERNAME'
|
1200
|
+
config.password = 'YOUR PASSWORD'
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1204
|
+
|
1205
|
+
organization = "organization_example" # String | Name of the organization
|
1206
|
+
|
1207
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1208
|
+
|
1209
|
+
|
1210
|
+
begin
|
1211
|
+
result = api_instance.get_pipeline_runs(organization, pipeline, )
|
1212
|
+
p result
|
1213
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1214
|
+
puts "Exception when calling BlueOceanApi->get_pipeline_runs: #{e}"
|
1215
|
+
end
|
1216
|
+
```
|
1217
|
+
|
1218
|
+
### Parameters
|
1219
|
+
|
1220
|
+
Name | Type | Description | Notes
|
1221
|
+
------------- | ------------- | ------------- | -------------
|
1222
|
+
**organization** | **String**| Name of the organization |
|
1223
|
+
**pipeline** | **String**| Name of the pipeline |
|
1224
|
+
|
1225
|
+
### Return type
|
1226
|
+
|
1227
|
+
[**PipelineRuns**](PipelineRuns.md)
|
1228
|
+
|
1229
|
+
### Authorization
|
1230
|
+
|
1231
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1232
|
+
|
1233
|
+
### HTTP request headers
|
1234
|
+
|
1235
|
+
- **Content-Type**: Not defined
|
1236
|
+
- **Accept**: application/json
|
1237
|
+
|
1238
|
+
|
1239
|
+
|
1240
|
+
# **get_pipelines**
|
1241
|
+
> Pipelines get_pipelines(organization, )
|
1242
|
+
|
1243
|
+
|
1244
|
+
|
1245
|
+
Retrieve all pipelines details for an organization
|
1246
|
+
|
1247
|
+
### Example
|
1248
|
+
```ruby
|
1249
|
+
# load the gem
|
1250
|
+
require 'swaggy_jenkins'
|
1251
|
+
# setup authorization
|
1252
|
+
SwaggyJenkinsClient.configure do |config|
|
1253
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1254
|
+
config.username = 'YOUR USERNAME'
|
1255
|
+
config.password = 'YOUR PASSWORD'
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1259
|
+
|
1260
|
+
organization = "organization_example" # String | Name of the organization
|
1261
|
+
|
1262
|
+
|
1263
|
+
begin
|
1264
|
+
result = api_instance.get_pipelines(organization, )
|
1265
|
+
p result
|
1266
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1267
|
+
puts "Exception when calling BlueOceanApi->get_pipelines: #{e}"
|
1268
|
+
end
|
1269
|
+
```
|
1270
|
+
|
1271
|
+
### Parameters
|
1272
|
+
|
1273
|
+
Name | Type | Description | Notes
|
1274
|
+
------------- | ------------- | ------------- | -------------
|
1275
|
+
**organization** | **String**| Name of the organization |
|
1276
|
+
|
1277
|
+
### Return type
|
1278
|
+
|
1279
|
+
[**Pipelines**](Pipelines.md)
|
1280
|
+
|
1281
|
+
### Authorization
|
1282
|
+
|
1283
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1284
|
+
|
1285
|
+
### HTTP request headers
|
1286
|
+
|
1287
|
+
- **Content-Type**: Not defined
|
1288
|
+
- **Accept**: application/json
|
1289
|
+
|
1290
|
+
|
1291
|
+
|
1292
|
+
# **get_scm**
|
1293
|
+
> GithubScm get_scm(organization, scm, )
|
1294
|
+
|
1295
|
+
|
1296
|
+
|
1297
|
+
Retrieve SCM details for an organization
|
1298
|
+
|
1299
|
+
### Example
|
1300
|
+
```ruby
|
1301
|
+
# load the gem
|
1302
|
+
require 'swaggy_jenkins'
|
1303
|
+
# setup authorization
|
1304
|
+
SwaggyJenkinsClient.configure do |config|
|
1305
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1306
|
+
config.username = 'YOUR USERNAME'
|
1307
|
+
config.password = 'YOUR PASSWORD'
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1311
|
+
|
1312
|
+
organization = "organization_example" # String | Name of the organization
|
1313
|
+
|
1314
|
+
scm = "scm_example" # String | Name of SCM
|
1315
|
+
|
1316
|
+
|
1317
|
+
begin
|
1318
|
+
result = api_instance.get_scm(organization, scm, )
|
1319
|
+
p result
|
1320
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1321
|
+
puts "Exception when calling BlueOceanApi->get_scm: #{e}"
|
1322
|
+
end
|
1323
|
+
```
|
1324
|
+
|
1325
|
+
### Parameters
|
1326
|
+
|
1327
|
+
Name | Type | Description | Notes
|
1328
|
+
------------- | ------------- | ------------- | -------------
|
1329
|
+
**organization** | **String**| Name of the organization |
|
1330
|
+
**scm** | **String**| Name of SCM |
|
1331
|
+
|
1332
|
+
### Return type
|
1333
|
+
|
1334
|
+
[**GithubScm**](GithubScm.md)
|
1335
|
+
|
1336
|
+
### Authorization
|
1337
|
+
|
1338
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1339
|
+
|
1340
|
+
### HTTP request headers
|
1341
|
+
|
1342
|
+
- **Content-Type**: Not defined
|
1343
|
+
- **Accept**: application/json
|
1344
|
+
|
1345
|
+
|
1346
|
+
|
1347
|
+
# **get_scm_organisation_repositories**
|
1348
|
+
> ScmOrganisations get_scm_organisation_repositories(organization, scm, scm_organisation, , opts)
|
1349
|
+
|
1350
|
+
|
1351
|
+
|
1352
|
+
Retrieve SCM organization repositories details for an organization
|
1353
|
+
|
1354
|
+
### Example
|
1355
|
+
```ruby
|
1356
|
+
# load the gem
|
1357
|
+
require 'swaggy_jenkins'
|
1358
|
+
# setup authorization
|
1359
|
+
SwaggyJenkinsClient.configure do |config|
|
1360
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1361
|
+
config.username = 'YOUR USERNAME'
|
1362
|
+
config.password = 'YOUR PASSWORD'
|
1363
|
+
end
|
1364
|
+
|
1365
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1366
|
+
|
1367
|
+
organization = "organization_example" # String | Name of the organization
|
1368
|
+
|
1369
|
+
scm = "scm_example" # String | Name of SCM
|
1370
|
+
|
1371
|
+
scm_organisation = "scm_organisation_example" # String | Name of the SCM organization
|
1372
|
+
|
1373
|
+
opts = {
|
1374
|
+
credential_id: "credential_id_example", # String | Credential ID
|
1375
|
+
page_size: 56, # Integer | Number of items in a page
|
1376
|
+
page_number: 56 # Integer | Page number
|
1377
|
+
}
|
1378
|
+
|
1379
|
+
begin
|
1380
|
+
result = api_instance.get_scm_organisation_repositories(organization, scm, scm_organisation, , opts)
|
1381
|
+
p result
|
1382
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1383
|
+
puts "Exception when calling BlueOceanApi->get_scm_organisation_repositories: #{e}"
|
1384
|
+
end
|
1385
|
+
```
|
1386
|
+
|
1387
|
+
### Parameters
|
1388
|
+
|
1389
|
+
Name | Type | Description | Notes
|
1390
|
+
------------- | ------------- | ------------- | -------------
|
1391
|
+
**organization** | **String**| Name of the organization |
|
1392
|
+
**scm** | **String**| Name of SCM |
|
1393
|
+
**scm_organisation** | **String**| Name of the SCM organization |
|
1394
|
+
**credential_id** | **String**| Credential ID | [optional]
|
1395
|
+
**page_size** | **Integer**| Number of items in a page | [optional]
|
1396
|
+
**page_number** | **Integer**| Page number | [optional]
|
1397
|
+
|
1398
|
+
### Return type
|
1399
|
+
|
1400
|
+
[**ScmOrganisations**](ScmOrganisations.md)
|
1401
|
+
|
1402
|
+
### Authorization
|
1403
|
+
|
1404
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1405
|
+
|
1406
|
+
### HTTP request headers
|
1407
|
+
|
1408
|
+
- **Content-Type**: Not defined
|
1409
|
+
- **Accept**: application/json
|
1410
|
+
|
1411
|
+
|
1412
|
+
|
1413
|
+
# **get_scm_organisation_repository**
|
1414
|
+
> ScmOrganisations get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
|
1415
|
+
|
1416
|
+
|
1417
|
+
|
1418
|
+
Retrieve SCM organization repository details for an organization
|
1419
|
+
|
1420
|
+
### Example
|
1421
|
+
```ruby
|
1422
|
+
# load the gem
|
1423
|
+
require 'swaggy_jenkins'
|
1424
|
+
# setup authorization
|
1425
|
+
SwaggyJenkinsClient.configure do |config|
|
1426
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1427
|
+
config.username = 'YOUR USERNAME'
|
1428
|
+
config.password = 'YOUR PASSWORD'
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1432
|
+
|
1433
|
+
organization = "organization_example" # String | Name of the organization
|
1434
|
+
|
1435
|
+
scm = "scm_example" # String | Name of SCM
|
1436
|
+
|
1437
|
+
scm_organisation = "scm_organisation_example" # String | Name of the SCM organization
|
1438
|
+
|
1439
|
+
repository = "repository_example" # String | Name of the SCM repository
|
1440
|
+
|
1441
|
+
opts = {
|
1442
|
+
credential_id: "credential_id_example" # String | Credential ID
|
1443
|
+
}
|
1444
|
+
|
1445
|
+
begin
|
1446
|
+
result = api_instance.get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
|
1447
|
+
p result
|
1448
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1449
|
+
puts "Exception when calling BlueOceanApi->get_scm_organisation_repository: #{e}"
|
1450
|
+
end
|
1451
|
+
```
|
1452
|
+
|
1453
|
+
### Parameters
|
1454
|
+
|
1455
|
+
Name | Type | Description | Notes
|
1456
|
+
------------- | ------------- | ------------- | -------------
|
1457
|
+
**organization** | **String**| Name of the organization |
|
1458
|
+
**scm** | **String**| Name of SCM |
|
1459
|
+
**scm_organisation** | **String**| Name of the SCM organization |
|
1460
|
+
**repository** | **String**| Name of the SCM repository |
|
1461
|
+
**credential_id** | **String**| Credential ID | [optional]
|
1462
|
+
|
1463
|
+
### Return type
|
1464
|
+
|
1465
|
+
[**ScmOrganisations**](ScmOrganisations.md)
|
1466
|
+
|
1467
|
+
### Authorization
|
1468
|
+
|
1469
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1470
|
+
|
1471
|
+
### HTTP request headers
|
1472
|
+
|
1473
|
+
- **Content-Type**: Not defined
|
1474
|
+
- **Accept**: application/json
|
1475
|
+
|
1476
|
+
|
1477
|
+
|
1478
|
+
# **get_scm_organisations**
|
1479
|
+
> ScmOrganisations get_scm_organisations(organization, scm, , opts)
|
1480
|
+
|
1481
|
+
|
1482
|
+
|
1483
|
+
Retrieve SCM organizations details for an organization
|
1484
|
+
|
1485
|
+
### Example
|
1486
|
+
```ruby
|
1487
|
+
# load the gem
|
1488
|
+
require 'swaggy_jenkins'
|
1489
|
+
# setup authorization
|
1490
|
+
SwaggyJenkinsClient.configure do |config|
|
1491
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1492
|
+
config.username = 'YOUR USERNAME'
|
1493
|
+
config.password = 'YOUR PASSWORD'
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1497
|
+
|
1498
|
+
organization = "organization_example" # String | Name of the organization
|
1499
|
+
|
1500
|
+
scm = "scm_example" # String | Name of SCM
|
1501
|
+
|
1502
|
+
opts = {
|
1503
|
+
credential_id: "credential_id_example" # String | Credential ID
|
1504
|
+
}
|
1505
|
+
|
1506
|
+
begin
|
1507
|
+
result = api_instance.get_scm_organisations(organization, scm, , opts)
|
1508
|
+
p result
|
1509
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1510
|
+
puts "Exception when calling BlueOceanApi->get_scm_organisations: #{e}"
|
1511
|
+
end
|
1512
|
+
```
|
1513
|
+
|
1514
|
+
### Parameters
|
1515
|
+
|
1516
|
+
Name | Type | Description | Notes
|
1517
|
+
------------- | ------------- | ------------- | -------------
|
1518
|
+
**organization** | **String**| Name of the organization |
|
1519
|
+
**scm** | **String**| Name of SCM |
|
1520
|
+
**credential_id** | **String**| Credential ID | [optional]
|
1521
|
+
|
1522
|
+
### Return type
|
1523
|
+
|
1524
|
+
[**ScmOrganisations**](ScmOrganisations.md)
|
1525
|
+
|
1526
|
+
### Authorization
|
1527
|
+
|
1528
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1529
|
+
|
1530
|
+
### HTTP request headers
|
1531
|
+
|
1532
|
+
- **Content-Type**: Not defined
|
1533
|
+
- **Accept**: application/json
|
1534
|
+
|
1535
|
+
|
1536
|
+
|
1537
|
+
# **get_user**
|
1538
|
+
> User get_user(organization, user)
|
1539
|
+
|
1540
|
+
|
1541
|
+
|
1542
|
+
Retrieve user details for an organization
|
1543
|
+
|
1544
|
+
### Example
|
1545
|
+
```ruby
|
1546
|
+
# load the gem
|
1547
|
+
require 'swaggy_jenkins'
|
1548
|
+
# setup authorization
|
1549
|
+
SwaggyJenkinsClient.configure do |config|
|
1550
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1551
|
+
config.username = 'YOUR USERNAME'
|
1552
|
+
config.password = 'YOUR PASSWORD'
|
1553
|
+
end
|
1554
|
+
|
1555
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1556
|
+
|
1557
|
+
organization = "organization_example" # String | Name of the organization
|
1558
|
+
|
1559
|
+
user = "user_example" # String | Name of the user
|
1560
|
+
|
1561
|
+
|
1562
|
+
begin
|
1563
|
+
result = api_instance.get_user(organization, user)
|
1564
|
+
p result
|
1565
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1566
|
+
puts "Exception when calling BlueOceanApi->get_user: #{e}"
|
1567
|
+
end
|
1568
|
+
```
|
1569
|
+
|
1570
|
+
### Parameters
|
1571
|
+
|
1572
|
+
Name | Type | Description | Notes
|
1573
|
+
------------- | ------------- | ------------- | -------------
|
1574
|
+
**organization** | **String**| Name of the organization |
|
1575
|
+
**user** | **String**| Name of the user |
|
1576
|
+
|
1577
|
+
### Return type
|
1578
|
+
|
1579
|
+
[**User**](User.md)
|
1580
|
+
|
1581
|
+
### Authorization
|
1582
|
+
|
1583
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1584
|
+
|
1585
|
+
### HTTP request headers
|
1586
|
+
|
1587
|
+
- **Content-Type**: Not defined
|
1588
|
+
- **Accept**: application/json
|
1589
|
+
|
1590
|
+
|
1591
|
+
|
1592
|
+
# **get_user_favorites**
|
1593
|
+
> UserFavorites get_user_favorites(user)
|
1594
|
+
|
1595
|
+
|
1596
|
+
|
1597
|
+
Retrieve user favorites details for an organization
|
1598
|
+
|
1599
|
+
### Example
|
1600
|
+
```ruby
|
1601
|
+
# load the gem
|
1602
|
+
require 'swaggy_jenkins'
|
1603
|
+
# setup authorization
|
1604
|
+
SwaggyJenkinsClient.configure do |config|
|
1605
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1606
|
+
config.username = 'YOUR USERNAME'
|
1607
|
+
config.password = 'YOUR PASSWORD'
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1611
|
+
|
1612
|
+
user = "user_example" # String | Name of the user
|
1613
|
+
|
1614
|
+
|
1615
|
+
begin
|
1616
|
+
result = api_instance.get_user_favorites(user)
|
1617
|
+
p result
|
1618
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1619
|
+
puts "Exception when calling BlueOceanApi->get_user_favorites: #{e}"
|
1620
|
+
end
|
1621
|
+
```
|
1622
|
+
|
1623
|
+
### Parameters
|
1624
|
+
|
1625
|
+
Name | Type | Description | Notes
|
1626
|
+
------------- | ------------- | ------------- | -------------
|
1627
|
+
**user** | **String**| Name of the user |
|
1628
|
+
|
1629
|
+
### Return type
|
1630
|
+
|
1631
|
+
[**UserFavorites**](UserFavorites.md)
|
1632
|
+
|
1633
|
+
### Authorization
|
1634
|
+
|
1635
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1636
|
+
|
1637
|
+
### HTTP request headers
|
1638
|
+
|
1639
|
+
- **Content-Type**: Not defined
|
1640
|
+
- **Accept**: application/json
|
1641
|
+
|
1642
|
+
|
1643
|
+
|
1644
|
+
# **get_users**
|
1645
|
+
> User get_users(organization, )
|
1646
|
+
|
1647
|
+
|
1648
|
+
|
1649
|
+
Retrieve users details for an organization
|
1650
|
+
|
1651
|
+
### Example
|
1652
|
+
```ruby
|
1653
|
+
# load the gem
|
1654
|
+
require 'swaggy_jenkins'
|
1655
|
+
# setup authorization
|
1656
|
+
SwaggyJenkinsClient.configure do |config|
|
1657
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1658
|
+
config.username = 'YOUR USERNAME'
|
1659
|
+
config.password = 'YOUR PASSWORD'
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1663
|
+
|
1664
|
+
organization = "organization_example" # String | Name of the organization
|
1665
|
+
|
1666
|
+
|
1667
|
+
begin
|
1668
|
+
result = api_instance.get_users(organization, )
|
1669
|
+
p result
|
1670
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1671
|
+
puts "Exception when calling BlueOceanApi->get_users: #{e}"
|
1672
|
+
end
|
1673
|
+
```
|
1674
|
+
|
1675
|
+
### Parameters
|
1676
|
+
|
1677
|
+
Name | Type | Description | Notes
|
1678
|
+
------------- | ------------- | ------------- | -------------
|
1679
|
+
**organization** | **String**| Name of the organization |
|
1680
|
+
|
1681
|
+
### Return type
|
1682
|
+
|
1683
|
+
[**User**](User.md)
|
1684
|
+
|
1685
|
+
### Authorization
|
1686
|
+
|
1687
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1688
|
+
|
1689
|
+
### HTTP request headers
|
1690
|
+
|
1691
|
+
- **Content-Type**: Not defined
|
1692
|
+
- **Accept**: application/json
|
1693
|
+
|
1694
|
+
|
1695
|
+
|
1696
|
+
# **post_pipeline_run**
|
1697
|
+
> QueueItemImpl post_pipeline_run(organization, pipeline, run)
|
1698
|
+
|
1699
|
+
|
1700
|
+
|
1701
|
+
Replay an organization pipeline run
|
1702
|
+
|
1703
|
+
### Example
|
1704
|
+
```ruby
|
1705
|
+
# load the gem
|
1706
|
+
require 'swaggy_jenkins'
|
1707
|
+
# setup authorization
|
1708
|
+
SwaggyJenkinsClient.configure do |config|
|
1709
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1710
|
+
config.username = 'YOUR USERNAME'
|
1711
|
+
config.password = 'YOUR PASSWORD'
|
1712
|
+
end
|
1713
|
+
|
1714
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1715
|
+
|
1716
|
+
organization = "organization_example" # String | Name of the organization
|
1717
|
+
|
1718
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1719
|
+
|
1720
|
+
run = "run_example" # String | Name of the run
|
1721
|
+
|
1722
|
+
|
1723
|
+
begin
|
1724
|
+
result = api_instance.post_pipeline_run(organization, pipeline, run)
|
1725
|
+
p result
|
1726
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1727
|
+
puts "Exception when calling BlueOceanApi->post_pipeline_run: #{e}"
|
1728
|
+
end
|
1729
|
+
```
|
1730
|
+
|
1731
|
+
### Parameters
|
1732
|
+
|
1733
|
+
Name | Type | Description | Notes
|
1734
|
+
------------- | ------------- | ------------- | -------------
|
1735
|
+
**organization** | **String**| Name of the organization |
|
1736
|
+
**pipeline** | **String**| Name of the pipeline |
|
1737
|
+
**run** | **String**| Name of the run |
|
1738
|
+
|
1739
|
+
### Return type
|
1740
|
+
|
1741
|
+
[**QueueItemImpl**](QueueItemImpl.md)
|
1742
|
+
|
1743
|
+
### Authorization
|
1744
|
+
|
1745
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1746
|
+
|
1747
|
+
### HTTP request headers
|
1748
|
+
|
1749
|
+
- **Content-Type**: Not defined
|
1750
|
+
- **Accept**: application/json
|
1751
|
+
|
1752
|
+
|
1753
|
+
|
1754
|
+
# **post_pipeline_runs**
|
1755
|
+
> QueueItemImpl post_pipeline_runs(organization, pipeline, )
|
1756
|
+
|
1757
|
+
|
1758
|
+
|
1759
|
+
Start a build for an organization pipeline
|
1760
|
+
|
1761
|
+
### Example
|
1762
|
+
```ruby
|
1763
|
+
# load the gem
|
1764
|
+
require 'swaggy_jenkins'
|
1765
|
+
# setup authorization
|
1766
|
+
SwaggyJenkinsClient.configure do |config|
|
1767
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1768
|
+
config.username = 'YOUR USERNAME'
|
1769
|
+
config.password = 'YOUR PASSWORD'
|
1770
|
+
end
|
1771
|
+
|
1772
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1773
|
+
|
1774
|
+
organization = "organization_example" # String | Name of the organization
|
1775
|
+
|
1776
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1777
|
+
|
1778
|
+
|
1779
|
+
begin
|
1780
|
+
result = api_instance.post_pipeline_runs(organization, pipeline, )
|
1781
|
+
p result
|
1782
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1783
|
+
puts "Exception when calling BlueOceanApi->post_pipeline_runs: #{e}"
|
1784
|
+
end
|
1785
|
+
```
|
1786
|
+
|
1787
|
+
### Parameters
|
1788
|
+
|
1789
|
+
Name | Type | Description | Notes
|
1790
|
+
------------- | ------------- | ------------- | -------------
|
1791
|
+
**organization** | **String**| Name of the organization |
|
1792
|
+
**pipeline** | **String**| Name of the pipeline |
|
1793
|
+
|
1794
|
+
### Return type
|
1795
|
+
|
1796
|
+
[**QueueItemImpl**](QueueItemImpl.md)
|
1797
|
+
|
1798
|
+
### Authorization
|
1799
|
+
|
1800
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1801
|
+
|
1802
|
+
### HTTP request headers
|
1803
|
+
|
1804
|
+
- **Content-Type**: Not defined
|
1805
|
+
- **Accept**: application/json
|
1806
|
+
|
1807
|
+
|
1808
|
+
|
1809
|
+
# **put_pipeline_favorite**
|
1810
|
+
> FavoriteImpl put_pipeline_favorite(organization, pipeline, body)
|
1811
|
+
|
1812
|
+
|
1813
|
+
|
1814
|
+
Favorite/unfavorite a pipeline
|
1815
|
+
|
1816
|
+
### Example
|
1817
|
+
```ruby
|
1818
|
+
# load the gem
|
1819
|
+
require 'swaggy_jenkins'
|
1820
|
+
# setup authorization
|
1821
|
+
SwaggyJenkinsClient.configure do |config|
|
1822
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1823
|
+
config.username = 'YOUR USERNAME'
|
1824
|
+
config.password = 'YOUR PASSWORD'
|
1825
|
+
end
|
1826
|
+
|
1827
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1828
|
+
|
1829
|
+
organization = "organization_example" # String | Name of the organization
|
1830
|
+
|
1831
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1832
|
+
|
1833
|
+
body = SwaggyJenkinsClient::Body.new # Body | Set JSON string body to {\"favorite\": true} to favorite, set value to false to unfavorite
|
1834
|
+
|
1835
|
+
|
1836
|
+
begin
|
1837
|
+
result = api_instance.put_pipeline_favorite(organization, pipeline, body)
|
1838
|
+
p result
|
1839
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1840
|
+
puts "Exception when calling BlueOceanApi->put_pipeline_favorite: #{e}"
|
1841
|
+
end
|
1842
|
+
```
|
1843
|
+
|
1844
|
+
### Parameters
|
1845
|
+
|
1846
|
+
Name | Type | Description | Notes
|
1847
|
+
------------- | ------------- | ------------- | -------------
|
1848
|
+
**organization** | **String**| Name of the organization |
|
1849
|
+
**pipeline** | **String**| Name of the pipeline |
|
1850
|
+
**body** | [**Body**](Body.md)| Set JSON string body to {\"favorite\": true} to favorite, set value to false to unfavorite |
|
1851
|
+
|
1852
|
+
### Return type
|
1853
|
+
|
1854
|
+
[**FavoriteImpl**](FavoriteImpl.md)
|
1855
|
+
|
1856
|
+
### Authorization
|
1857
|
+
|
1858
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1859
|
+
|
1860
|
+
### HTTP request headers
|
1861
|
+
|
1862
|
+
- **Content-Type**: Not defined
|
1863
|
+
- **Accept**: application/json
|
1864
|
+
|
1865
|
+
|
1866
|
+
|
1867
|
+
# **put_pipeline_run**
|
1868
|
+
> PipelineRun put_pipeline_run(organization, pipeline, run, opts)
|
1869
|
+
|
1870
|
+
|
1871
|
+
|
1872
|
+
Stop a build of an organization pipeline
|
1873
|
+
|
1874
|
+
### Example
|
1875
|
+
```ruby
|
1876
|
+
# load the gem
|
1877
|
+
require 'swaggy_jenkins'
|
1878
|
+
# setup authorization
|
1879
|
+
SwaggyJenkinsClient.configure do |config|
|
1880
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1881
|
+
config.username = 'YOUR USERNAME'
|
1882
|
+
config.password = 'YOUR PASSWORD'
|
1883
|
+
end
|
1884
|
+
|
1885
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1886
|
+
|
1887
|
+
organization = "organization_example" # String | Name of the organization
|
1888
|
+
|
1889
|
+
pipeline = "pipeline_example" # String | Name of the pipeline
|
1890
|
+
|
1891
|
+
run = "run_example" # String | Name of the run
|
1892
|
+
|
1893
|
+
opts = {
|
1894
|
+
blocking: "blocking_example", # String | Set to true to make blocking stop, default: false
|
1895
|
+
time_out_in_secs: 56 # Integer | Timeout in seconds, default: 10 seconds
|
1896
|
+
}
|
1897
|
+
|
1898
|
+
begin
|
1899
|
+
result = api_instance.put_pipeline_run(organization, pipeline, run, opts)
|
1900
|
+
p result
|
1901
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1902
|
+
puts "Exception when calling BlueOceanApi->put_pipeline_run: #{e}"
|
1903
|
+
end
|
1904
|
+
```
|
1905
|
+
|
1906
|
+
### Parameters
|
1907
|
+
|
1908
|
+
Name | Type | Description | Notes
|
1909
|
+
------------- | ------------- | ------------- | -------------
|
1910
|
+
**organization** | **String**| Name of the organization |
|
1911
|
+
**pipeline** | **String**| Name of the pipeline |
|
1912
|
+
**run** | **String**| Name of the run |
|
1913
|
+
**blocking** | **String**| Set to true to make blocking stop, default: false | [optional]
|
1914
|
+
**time_out_in_secs** | **Integer**| Timeout in seconds, default: 10 seconds | [optional]
|
1915
|
+
|
1916
|
+
### Return type
|
1917
|
+
|
1918
|
+
[**PipelineRun**](PipelineRun.md)
|
1919
|
+
|
1920
|
+
### Authorization
|
1921
|
+
|
1922
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1923
|
+
|
1924
|
+
### HTTP request headers
|
1925
|
+
|
1926
|
+
- **Content-Type**: Not defined
|
1927
|
+
- **Accept**: application/json
|
1928
|
+
|
1929
|
+
|
1930
|
+
|
1931
|
+
# **search**
|
1932
|
+
> String search(q)
|
1933
|
+
|
1934
|
+
|
1935
|
+
|
1936
|
+
Search for any resource details
|
1937
|
+
|
1938
|
+
### Example
|
1939
|
+
```ruby
|
1940
|
+
# load the gem
|
1941
|
+
require 'swaggy_jenkins'
|
1942
|
+
# setup authorization
|
1943
|
+
SwaggyJenkinsClient.configure do |config|
|
1944
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1945
|
+
config.username = 'YOUR USERNAME'
|
1946
|
+
config.password = 'YOUR PASSWORD'
|
1947
|
+
end
|
1948
|
+
|
1949
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
1950
|
+
|
1951
|
+
q = "q_example" # String | Query string
|
1952
|
+
|
1953
|
+
|
1954
|
+
begin
|
1955
|
+
result = api_instance.search(q)
|
1956
|
+
p result
|
1957
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1958
|
+
puts "Exception when calling BlueOceanApi->search: #{e}"
|
1959
|
+
end
|
1960
|
+
```
|
1961
|
+
|
1962
|
+
### Parameters
|
1963
|
+
|
1964
|
+
Name | Type | Description | Notes
|
1965
|
+
------------- | ------------- | ------------- | -------------
|
1966
|
+
**q** | **String**| Query string |
|
1967
|
+
|
1968
|
+
### Return type
|
1969
|
+
|
1970
|
+
**String**
|
1971
|
+
|
1972
|
+
### Authorization
|
1973
|
+
|
1974
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1975
|
+
|
1976
|
+
### HTTP request headers
|
1977
|
+
|
1978
|
+
- **Content-Type**: Not defined
|
1979
|
+
- **Accept**: application/json
|
1980
|
+
|
1981
|
+
|
1982
|
+
|
1983
|
+
# **search_classes**
|
1984
|
+
> String search_classes(q)
|
1985
|
+
|
1986
|
+
|
1987
|
+
|
1988
|
+
Get classes details
|
1989
|
+
|
1990
|
+
### Example
|
1991
|
+
```ruby
|
1992
|
+
# load the gem
|
1993
|
+
require 'swaggy_jenkins'
|
1994
|
+
# setup authorization
|
1995
|
+
SwaggyJenkinsClient.configure do |config|
|
1996
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1997
|
+
config.username = 'YOUR USERNAME'
|
1998
|
+
config.password = 'YOUR PASSWORD'
|
1999
|
+
end
|
2000
|
+
|
2001
|
+
api_instance = SwaggyJenkinsClient::BlueOceanApi.new
|
2002
|
+
|
2003
|
+
q = "q_example" # String | Query string containing an array of class names
|
2004
|
+
|
2005
|
+
|
2006
|
+
begin
|
2007
|
+
result = api_instance.search_classes(q)
|
2008
|
+
p result
|
2009
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
2010
|
+
puts "Exception when calling BlueOceanApi->search_classes: #{e}"
|
2011
|
+
end
|
2012
|
+
```
|
2013
|
+
|
2014
|
+
### Parameters
|
2015
|
+
|
2016
|
+
Name | Type | Description | Notes
|
2017
|
+
------------- | ------------- | ------------- | -------------
|
2018
|
+
**q** | **String**| Query string containing an array of class names |
|
2019
|
+
|
2020
|
+
### Return type
|
2021
|
+
|
2022
|
+
**String**
|
2023
|
+
|
2024
|
+
### Authorization
|
2025
|
+
|
2026
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
2027
|
+
|
2028
|
+
### HTTP request headers
|
2029
|
+
|
2030
|
+
- **Content-Type**: Not defined
|
2031
|
+
- **Accept**: application/json
|
2032
|
+
|
2033
|
+
|
2034
|
+
|