swaggy_jenkins 0.0.1 → 1.3.0

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.
Files changed (315) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +51 -50
  4. data/README.md +25 -33
  5. data/Rakefile +2 -0
  6. data/bin/bundle +114 -0
  7. data/bin/byebug +29 -0
  8. data/bin/coderay +29 -0
  9. data/bin/htmldiff +29 -0
  10. data/bin/ldiff +29 -0
  11. data/bin/pry +29 -0
  12. data/bin/rake +29 -0
  13. data/bin/rspec +29 -0
  14. data/bin/rubocop +29 -0
  15. data/bin/ruby-parse +29 -0
  16. data/bin/ruby-rewrite +29 -0
  17. data/docs/AllView.md +17 -5
  18. data/docs/BaseApi.md +75 -0
  19. data/docs/BlueOceanApi.md +1347 -631
  20. data/docs/BranchImpl.md +37 -15
  21. data/docs/BranchImpllinks.md +21 -7
  22. data/docs/BranchImplpermissions.md +21 -7
  23. data/docs/CauseAction.md +15 -4
  24. data/docs/CauseUserIdCause.md +19 -6
  25. data/docs/ClassesByClass.md +15 -4
  26. data/docs/ClockDifference.md +15 -4
  27. data/docs/ComputerSet.md +21 -7
  28. data/docs/DefaultCrumbIssuer.md +17 -5
  29. data/docs/DiskSpaceMonitorDescriptorDiskSpace.md +19 -6
  30. data/docs/EmptyChangeLogSet.md +15 -4
  31. data/docs/ExtensionClassContainerImpl1.md +17 -5
  32. data/docs/ExtensionClassContainerImpl1links.md +15 -4
  33. data/docs/ExtensionClassContainerImpl1map.md +17 -5
  34. data/docs/ExtensionClassImpl.md +17 -5
  35. data/docs/ExtensionClassImpllinks.md +15 -4
  36. data/docs/FavoriteImpl.md +17 -5
  37. data/docs/FavoriteImpllinks.md +15 -4
  38. data/docs/FreeStyleBuild.md +47 -20
  39. data/docs/FreeStyleProject.md +65 -29
  40. data/docs/FreeStyleProjectactions.md +13 -3
  41. data/docs/FreeStyleProjecthealthReport.md +21 -7
  42. data/docs/GenericResource.md +23 -8
  43. data/docs/GithubContent.md +27 -10
  44. data/docs/GithubFile.md +15 -4
  45. data/docs/GithubOrganization.md +19 -6
  46. data/docs/GithubOrganizationlinks.md +17 -5
  47. data/docs/GithubRepositories.md +23 -8
  48. data/docs/GithubRepositorieslinks.md +15 -4
  49. data/docs/GithubRepository.md +27 -10
  50. data/docs/GithubRepositorylinks.md +15 -4
  51. data/docs/GithubRepositorypermissions.md +19 -6
  52. data/docs/GithubRespositoryContainer.md +17 -5
  53. data/docs/GithubRespositoryContainerlinks.md +15 -4
  54. data/docs/GithubScm.md +21 -7
  55. data/docs/GithubScmlinks.md +15 -4
  56. data/docs/Hudson.md +41 -17
  57. data/docs/HudsonMasterComputer.md +43 -18
  58. data/docs/HudsonMasterComputerexecutors.md +23 -8
  59. data/docs/HudsonMasterComputermonitorData.md +25 -9
  60. data/docs/HudsonassignedLabels.md +13 -3
  61. data/docs/InputStepImpl.md +25 -9
  62. data/docs/InputStepImpllinks.md +15 -4
  63. data/docs/Label1.md +13 -3
  64. data/docs/Link.md +15 -4
  65. data/docs/ListView.md +21 -7
  66. data/docs/MultibranchPipeline.md +39 -16
  67. data/docs/NullSCM.md +13 -3
  68. data/docs/Organisation.md +15 -4
  69. data/docs/Pipeline.md +27 -10
  70. data/docs/PipelineActivity.md +41 -17
  71. data/docs/PipelineActivityartifacts.md +19 -6
  72. data/docs/PipelineBranchesitem.md +29 -11
  73. data/docs/PipelineBranchesitemlatestRun.md +39 -16
  74. data/docs/PipelineBranchesitempullRequest.md +23 -8
  75. data/docs/PipelineBranchesitempullRequestlinks.md +15 -4
  76. data/docs/PipelineFolderImpl.md +25 -9
  77. data/docs/PipelineImpl.md +29 -11
  78. data/docs/PipelineImpllinks.md +21 -7
  79. data/docs/PipelineRun.md +41 -17
  80. data/docs/PipelineRunImpl.md +41 -17
  81. data/docs/PipelineRunImpllinks.md +23 -8
  82. data/docs/PipelineRunNode.md +27 -10
  83. data/docs/PipelineRunNodeedges.md +15 -4
  84. data/docs/PipelineRunartifacts.md +19 -6
  85. data/docs/PipelineStepImpl.md +29 -11
  86. data/docs/PipelineStepImpllinks.md +17 -5
  87. data/docs/PipelinelatestRun.md +41 -17
  88. data/docs/PipelinelatestRunartifacts.md +19 -6
  89. data/docs/Queue.md +15 -4
  90. data/docs/QueueBlockedItem.md +35 -14
  91. data/docs/QueueItemImpl.md +21 -7
  92. data/docs/QueueLeftItem.md +37 -15
  93. data/docs/RemoteAccessApi.md +666 -350
  94. data/docs/ResponseTimeMonitorData.md +17 -5
  95. data/docs/StringParameterDefinition.md +21 -7
  96. data/docs/StringParameterValue.md +17 -5
  97. data/docs/SwapSpaceMonitorMemoryUsage2.md +21 -7
  98. data/docs/UnlabeledLoadStatistics.md +13 -3
  99. data/docs/User.md +21 -7
  100. data/git_push.sh +12 -10
  101. data/lib/swaggy_jenkins/api/base_api.rb +77 -0
  102. data/lib/swaggy_jenkins/api/blue_ocean_api.rb +1048 -643
  103. data/lib/swaggy_jenkins/api/remote_access_api.rb +506 -361
  104. data/lib/swaggy_jenkins/api_client.rb +95 -94
  105. data/lib/swaggy_jenkins/api_error.rb +22 -3
  106. data/lib/swaggy_jenkins/configuration.rb +91 -15
  107. data/lib/swaggy_jenkins/models/all_view.rb +59 -29
  108. data/lib/swaggy_jenkins/models/branch_impl.rb +76 -46
  109. data/lib/swaggy_jenkins/models/branch_impllinks.rb +62 -32
  110. data/lib/swaggy_jenkins/models/branch_implpermissions.rb +65 -35
  111. data/lib/swaggy_jenkins/models/cause_action.rb +58 -28
  112. data/lib/swaggy_jenkins/models/cause_user_id_cause.rb +63 -33
  113. data/lib/swaggy_jenkins/models/classes_by_class.rb +58 -28
  114. data/lib/swaggy_jenkins/models/clock_difference.rb +58 -28
  115. data/lib/swaggy_jenkins/models/computer_set.rb +64 -34
  116. data/lib/swaggy_jenkins/models/default_crumb_issuer.rb +60 -30
  117. data/lib/swaggy_jenkins/models/disk_space_monitor_descriptor_disk_space.rb +60 -30
  118. data/lib/swaggy_jenkins/models/empty_change_log_set.rb +58 -28
  119. data/lib/swaggy_jenkins/models/extension_class_container_impl1.rb +59 -29
  120. data/lib/swaggy_jenkins/models/extension_class_container_impl1links.rb +59 -29
  121. data/lib/swaggy_jenkins/models/extension_class_container_impl1map.rb +61 -31
  122. data/lib/swaggy_jenkins/models/extension_class_impl.rb +59 -29
  123. data/lib/swaggy_jenkins/models/extension_class_impllinks.rb +59 -29
  124. data/lib/swaggy_jenkins/models/favorite_impl.rb +59 -29
  125. data/lib/swaggy_jenkins/models/favorite_impllinks.rb +59 -29
  126. data/lib/swaggy_jenkins/models/free_style_build.rb +83 -53
  127. data/lib/swaggy_jenkins/models/free_style_project.rb +105 -75
  128. data/lib/swaggy_jenkins/models/free_style_projectactions.rb +57 -27
  129. data/lib/swaggy_jenkins/models/free_style_projecthealth_report.rb +63 -33
  130. data/lib/swaggy_jenkins/models/generic_resource.rb +65 -35
  131. data/lib/swaggy_jenkins/models/github_content.rb +65 -35
  132. data/lib/swaggy_jenkins/models/github_file.rb +58 -28
  133. data/lib/swaggy_jenkins/models/github_organization.rb +62 -32
  134. data/lib/swaggy_jenkins/models/github_organizationlinks.rb +60 -30
  135. data/lib/swaggy_jenkins/models/github_repositories.rb +65 -35
  136. data/lib/swaggy_jenkins/models/github_repositorieslinks.rb +59 -29
  137. data/lib/swaggy_jenkins/models/github_repository.rb +67 -37
  138. data/lib/swaggy_jenkins/models/github_repositorylinks.rb +59 -29
  139. data/lib/swaggy_jenkins/models/github_repositorypermissions.rb +63 -33
  140. data/lib/swaggy_jenkins/models/github_respository_container.rb +59 -29
  141. data/lib/swaggy_jenkins/models/github_respository_containerlinks.rb +59 -29
  142. data/lib/swaggy_jenkins/models/github_scm.rb +62 -32
  143. data/lib/swaggy_jenkins/models/github_scmlinks.rb +59 -29
  144. data/lib/swaggy_jenkins/models/hudson.rb +84 -54
  145. data/lib/swaggy_jenkins/models/hudson_master_computer.rb +89 -59
  146. data/lib/swaggy_jenkins/models/hudson_master_computerexecutors.rb +66 -36
  147. data/lib/swaggy_jenkins/models/hudson_master_computermonitor_data.rb +69 -39
  148. data/lib/swaggy_jenkins/models/hudsonassigned_labels.rb +57 -27
  149. data/lib/swaggy_jenkins/models/input_step_impl.rb +63 -33
  150. data/lib/swaggy_jenkins/models/input_step_impllinks.rb +59 -29
  151. data/lib/swaggy_jenkins/models/label1.rb +57 -27
  152. data/lib/swaggy_jenkins/models/link.rb +58 -28
  153. data/lib/swaggy_jenkins/models/list_view.rb +61 -31
  154. data/lib/swaggy_jenkins/models/multibranch_pipeline.rb +81 -51
  155. data/lib/swaggy_jenkins/models/null_scm.rb +57 -27
  156. data/lib/swaggy_jenkins/models/organisation.rb +58 -28
  157. data/lib/swaggy_jenkins/models/pipeline.rb +69 -39
  158. data/lib/swaggy_jenkins/models/pipeline_activity.rb +78 -48
  159. data/lib/swaggy_jenkins/models/pipeline_activityartifacts.rb +60 -30
  160. data/lib/swaggy_jenkins/models/pipeline_branchesitem.rb +71 -41
  161. data/lib/swaggy_jenkins/models/pipeline_branchesitemlatest_run.rb +77 -47
  162. data/lib/swaggy_jenkins/models/pipeline_branchesitempull_request.rb +62 -32
  163. data/lib/swaggy_jenkins/models/pipeline_branchesitempull_requestlinks.rb +59 -29
  164. data/lib/swaggy_jenkins/models/pipeline_folder_impl.rb +67 -37
  165. data/lib/swaggy_jenkins/models/pipeline_impl.rb +70 -40
  166. data/lib/swaggy_jenkins/models/pipeline_impllinks.rb +62 -32
  167. data/lib/swaggy_jenkins/models/pipeline_run.rb +78 -48
  168. data/lib/swaggy_jenkins/models/pipeline_run_impl.rb +78 -48
  169. data/lib/swaggy_jenkins/models/pipeline_run_impllinks.rb +63 -33
  170. data/lib/swaggy_jenkins/models/pipeline_run_node.rb +67 -37
  171. data/lib/swaggy_jenkins/models/pipeline_run_nodeedges.rb +58 -28
  172. data/lib/swaggy_jenkins/models/pipeline_runartifacts.rb +60 -30
  173. data/lib/swaggy_jenkins/models/pipeline_step_impl.rb +68 -38
  174. data/lib/swaggy_jenkins/models/pipeline_step_impllinks.rb +60 -30
  175. data/lib/swaggy_jenkins/models/pipelinelatest_run.rb +78 -48
  176. data/lib/swaggy_jenkins/models/pipelinelatest_runartifacts.rb +60 -30
  177. data/lib/swaggy_jenkins/models/queue.rb +58 -28
  178. data/lib/swaggy_jenkins/models/queue_blocked_item.rb +73 -43
  179. data/lib/swaggy_jenkins/models/queue_item_impl.rb +63 -33
  180. data/lib/swaggy_jenkins/models/queue_left_item.rb +74 -44
  181. data/lib/swaggy_jenkins/models/response_time_monitor_data.rb +59 -29
  182. data/lib/swaggy_jenkins/models/string_parameter_definition.rb +62 -32
  183. data/lib/swaggy_jenkins/models/string_parameter_value.rb +59 -29
  184. data/lib/swaggy_jenkins/models/swap_space_monitor_memory_usage2.rb +65 -35
  185. data/lib/swaggy_jenkins/models/unlabeled_load_statistics.rb +57 -27
  186. data/lib/swaggy_jenkins/models/user.rb +62 -32
  187. data/lib/swaggy_jenkins/version.rb +4 -4
  188. data/lib/swaggy_jenkins.rb +4 -16
  189. data/spec/api/base_api_spec.rb +45 -0
  190. data/spec/api/blue_ocean_api_spec.rb +76 -88
  191. data/spec/api/remote_access_api_spec.rb +28 -59
  192. data/spec/api_client_spec.rb +40 -40
  193. data/spec/configuration_spec.rb +11 -11
  194. data/spec/models/all_view_spec.rb +10 -18
  195. data/spec/models/branch_impl_spec.rb +20 -28
  196. data/spec/models/branch_impllinks_spec.rb +12 -20
  197. data/spec/models/branch_implpermissions_spec.rb +12 -20
  198. data/spec/models/cause_action_spec.rb +9 -17
  199. data/spec/models/cause_user_id_cause_spec.rb +11 -19
  200. data/spec/models/classes_by_class_spec.rb +9 -17
  201. data/spec/models/clock_difference_spec.rb +9 -17
  202. data/spec/models/computer_set_spec.rb +12 -20
  203. data/spec/models/default_crumb_issuer_spec.rb +10 -18
  204. data/spec/models/disk_space_monitor_descriptor_disk_space_spec.rb +11 -19
  205. data/spec/models/empty_change_log_set_spec.rb +9 -17
  206. data/spec/models/extension_class_container_impl1_spec.rb +10 -18
  207. data/spec/models/extension_class_container_impl1links_spec.rb +9 -17
  208. data/spec/models/extension_class_container_impl1map_spec.rb +10 -18
  209. data/spec/models/extension_class_impl_spec.rb +10 -18
  210. data/spec/models/extension_class_impllinks_spec.rb +9 -17
  211. data/spec/models/favorite_impl_spec.rb +10 -18
  212. data/spec/models/favorite_impllinks_spec.rb +9 -17
  213. data/spec/models/free_style_build_spec.rb +25 -33
  214. data/spec/models/free_style_project_spec.rb +34 -42
  215. data/spec/models/free_style_projectactions_spec.rb +8 -16
  216. data/spec/models/free_style_projecthealth_report_spec.rb +12 -20
  217. data/spec/models/generic_resource_spec.rb +13 -21
  218. data/spec/models/github_content_spec.rb +15 -23
  219. data/spec/models/github_file_spec.rb +9 -17
  220. data/spec/models/github_organization_spec.rb +11 -19
  221. data/spec/models/github_organizationlinks_spec.rb +10 -18
  222. data/spec/models/github_repositories_spec.rb +13 -21
  223. data/spec/models/github_repositorieslinks_spec.rb +9 -17
  224. data/spec/models/github_repository_spec.rb +15 -23
  225. data/spec/models/github_repositorylinks_spec.rb +9 -17
  226. data/spec/models/github_repositorypermissions_spec.rb +11 -19
  227. data/spec/models/github_respository_container_spec.rb +10 -18
  228. data/spec/models/github_respository_containerlinks_spec.rb +9 -17
  229. data/spec/models/github_scm_spec.rb +12 -20
  230. data/spec/models/github_scmlinks_spec.rb +9 -17
  231. data/spec/models/hudson_master_computer_spec.rb +23 -31
  232. data/spec/models/hudson_master_computerexecutors_spec.rb +13 -21
  233. data/spec/models/hudson_master_computermonitor_data_spec.rb +14 -22
  234. data/spec/models/hudson_spec.rb +22 -30
  235. data/spec/models/hudsonassigned_labels_spec.rb +8 -16
  236. data/spec/models/input_step_impl_spec.rb +14 -22
  237. data/spec/models/input_step_impllinks_spec.rb +9 -17
  238. data/spec/models/label1_spec.rb +8 -16
  239. data/spec/models/link_spec.rb +9 -17
  240. data/spec/models/list_view_spec.rb +12 -20
  241. data/spec/models/multibranch_pipeline_spec.rb +21 -29
  242. data/spec/models/null_scm_spec.rb +8 -16
  243. data/spec/models/organisation_spec.rb +9 -17
  244. data/spec/models/pipeline_activity_spec.rb +22 -30
  245. data/spec/models/pipeline_activityartifacts_spec.rb +11 -19
  246. data/spec/models/pipeline_branchesitem_spec.rb +16 -24
  247. data/spec/models/pipeline_branchesitemlatest_run_spec.rb +21 -29
  248. data/spec/models/pipeline_branchesitempull_request_spec.rb +13 -21
  249. data/spec/models/pipeline_branchesitempull_requestlinks_spec.rb +9 -17
  250. data/spec/models/pipeline_folder_impl_spec.rb +14 -22
  251. data/spec/models/pipeline_impl_spec.rb +16 -24
  252. data/spec/models/pipeline_impllinks_spec.rb +12 -20
  253. data/spec/models/pipeline_run_impl_spec.rb +22 -30
  254. data/spec/models/pipeline_run_impllinks_spec.rb +13 -21
  255. data/spec/models/pipeline_run_node_spec.rb +15 -23
  256. data/spec/models/pipeline_run_nodeedges_spec.rb +9 -17
  257. data/spec/models/pipeline_run_spec.rb +22 -30
  258. data/spec/models/pipeline_runartifacts_spec.rb +11 -19
  259. data/spec/models/pipeline_spec.rb +15 -23
  260. data/spec/models/pipeline_step_impl_spec.rb +16 -24
  261. data/spec/models/pipeline_step_impllinks_spec.rb +10 -18
  262. data/spec/models/pipelinelatest_run_spec.rb +22 -30
  263. data/spec/models/pipelinelatest_runartifacts_spec.rb +11 -19
  264. data/spec/models/queue_blocked_item_spec.rb +19 -27
  265. data/spec/models/queue_item_impl_spec.rb +12 -20
  266. data/spec/models/queue_left_item_spec.rb +20 -28
  267. data/spec/models/queue_spec.rb +9 -17
  268. data/spec/models/response_time_monitor_data_spec.rb +10 -18
  269. data/spec/models/string_parameter_definition_spec.rb +12 -20
  270. data/spec/models/string_parameter_value_spec.rb +10 -18
  271. data/spec/models/swap_space_monitor_memory_usage2_spec.rb +12 -20
  272. data/spec/models/unlabeled_load_statistics_spec.rb +8 -16
  273. data/spec/models/user_spec.rb +12 -20
  274. data/spec/spec_helper.rb +3 -3
  275. data/swaggy_jenkins.gemspec +6 -13
  276. metadata +97 -275
  277. data/docs/Body.md +0 -8
  278. data/docs/Organisations.md +0 -7
  279. data/docs/PipelineActivities.md +0 -7
  280. data/docs/PipelineBranches.md +0 -7
  281. data/docs/PipelineQueue.md +0 -7
  282. data/docs/PipelineRunNodeSteps.md +0 -7
  283. data/docs/PipelineRunNodes.md +0 -7
  284. data/docs/PipelineRunSteps.md +0 -7
  285. data/docs/PipelineRuns.md +0 -7
  286. data/docs/Pipelines.md +0 -7
  287. data/docs/ScmOrganisations.md +0 -7
  288. data/docs/UserFavorites.md +0 -7
  289. data/docs/Users.md +0 -7
  290. data/lib/swaggy_jenkins/models/body.rb +0 -193
  291. data/lib/swaggy_jenkins/models/organisations.rb +0 -179
  292. data/lib/swaggy_jenkins/models/pipeline_activities.rb +0 -179
  293. data/lib/swaggy_jenkins/models/pipeline_branches.rb +0 -179
  294. data/lib/swaggy_jenkins/models/pipeline_queue.rb +0 -179
  295. data/lib/swaggy_jenkins/models/pipeline_run_node_steps.rb +0 -179
  296. data/lib/swaggy_jenkins/models/pipeline_run_nodes.rb +0 -179
  297. data/lib/swaggy_jenkins/models/pipeline_run_steps.rb +0 -179
  298. data/lib/swaggy_jenkins/models/pipeline_runs.rb +0 -179
  299. data/lib/swaggy_jenkins/models/pipelines.rb +0 -179
  300. data/lib/swaggy_jenkins/models/scm_organisations.rb +0 -179
  301. data/lib/swaggy_jenkins/models/user_favorites.rb +0 -179
  302. data/lib/swaggy_jenkins/models/users.rb +0 -179
  303. data/spec/models/body_spec.rb +0 -42
  304. data/spec/models/organisations_spec.rb +0 -36
  305. data/spec/models/pipeline_activities_spec.rb +0 -36
  306. data/spec/models/pipeline_branches_spec.rb +0 -36
  307. data/spec/models/pipeline_queue_spec.rb +0 -36
  308. data/spec/models/pipeline_run_node_steps_spec.rb +0 -36
  309. data/spec/models/pipeline_run_nodes_spec.rb +0 -36
  310. data/spec/models/pipeline_run_steps_spec.rb +0 -36
  311. data/spec/models/pipeline_runs_spec.rb +0 -36
  312. data/spec/models/pipelines_spec.rb +0 -36
  313. data/spec/models/scm_organisations_spec.rb +0 -36
  314. data/spec/models/user_favorites_spec.rb +0 -36
  315. data/spec/models/users_spec.rb +0 -36
data/docs/BlueOceanApi.md CHANGED
@@ -2,55 +2,59 @@
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
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**
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_json_web_key**](BlueOceanApi.md#get_json_web_key) | **GET** /jwt-auth/jwks/{key} | |
11
+ | [**get_json_web_token**](BlueOceanApi.md#get_json_web_token) | **GET** /jwt-auth/token | |
12
+ | [**get_organisation**](BlueOceanApi.md#get_organisation) | **GET** /blue/rest/organizations/{organization} | |
13
+ | [**get_organisations**](BlueOceanApi.md#get_organisations) | **GET** /blue/rest/organizations/ | |
14
+ | [**get_pipeline**](BlueOceanApi.md#get_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline} | |
15
+ | [**get_pipeline_activities**](BlueOceanApi.md#get_pipeline_activities) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/activities | |
16
+ | [**get_pipeline_branch**](BlueOceanApi.md#get_pipeline_branch) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/ | |
17
+ | [**get_pipeline_branch_run**](BlueOceanApi.md#get_pipeline_branch_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run} | |
18
+ | [**get_pipeline_branches**](BlueOceanApi.md#get_pipeline_branches) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches | |
19
+ | [**get_pipeline_folder**](BlueOceanApi.md#get_pipeline_folder) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/ | |
20
+ | [**get_pipeline_folder_pipeline**](BlueOceanApi.md#get_pipeline_folder_pipeline) | **GET** /blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline} | |
21
+ | [**get_pipeline_queue**](BlueOceanApi.md#get_pipeline_queue) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue | |
22
+ | [**get_pipeline_run**](BlueOceanApi.md#get_pipeline_run) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run} | |
23
+ | [**get_pipeline_run_log**](BlueOceanApi.md#get_pipeline_run_log) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log | |
24
+ | [**get_pipeline_run_node**](BlueOceanApi.md#get_pipeline_run_node) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node} | |
25
+ | [**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} | |
26
+ | [**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 | |
27
+ | [**get_pipeline_run_node_steps**](BlueOceanApi.md#get_pipeline_run_node_steps) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps | |
28
+ | [**get_pipeline_run_nodes**](BlueOceanApi.md#get_pipeline_run_nodes) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes | |
29
+ | [**get_pipeline_runs**](BlueOceanApi.md#get_pipeline_runs) | **GET** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs | |
30
+ | [**get_pipelines**](BlueOceanApi.md#get_pipelines) | **GET** /blue/rest/organizations/{organization}/pipelines/ | |
31
+ | [**get_scm**](BlueOceanApi.md#get_scm) | **GET** /blue/rest/organizations/{organization}/scm/{scm} | |
32
+ | [**get_scm_organisation_repositories**](BlueOceanApi.md#get_scm_organisation_repositories) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories | |
33
+ | [**get_scm_organisation_repository**](BlueOceanApi.md#get_scm_organisation_repository) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository} | |
34
+ | [**get_scm_organisations**](BlueOceanApi.md#get_scm_organisations) | **GET** /blue/rest/organizations/{organization}/scm/{scm}/organizations | |
35
+ | [**get_user**](BlueOceanApi.md#get_user) | **GET** /blue/rest/organizations/{organization}/users/{user} | |
36
+ | [**get_user_favorites**](BlueOceanApi.md#get_user_favorites) | **GET** /blue/rest/users/{user}/favorites | |
37
+ | [**get_users**](BlueOceanApi.md#get_users) | **GET** /blue/rest/organizations/{organization}/users/ | |
38
+ | [**post_pipeline_run**](BlueOceanApi.md#post_pipeline_run) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay | |
39
+ | [**post_pipeline_runs**](BlueOceanApi.md#post_pipeline_runs) | **POST** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs | |
40
+ | [**put_pipeline_favorite**](BlueOceanApi.md#put_pipeline_favorite) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite | |
41
+ | [**put_pipeline_run**](BlueOceanApi.md#put_pipeline_run) | **PUT** /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop | |
42
+ | [**search**](BlueOceanApi.md#search) | **GET** /blue/rest/search/ | |
43
+ | [**search_classes**](BlueOceanApi.md#search_classes) | **GET** /blue/rest/classes/ | |
44
+
45
+
46
+ ## delete_pipeline_queue_item
47
+
45
48
  > delete_pipeline_queue_item(organization, pipeline, queue)
46
49
 
47
50
 
48
51
 
49
52
  Delete queue item from an organization pipeline queue
50
53
 
51
- ### Example
54
+ ### Examples
55
+
52
56
  ```ruby
53
- # load the gem
57
+ require 'time'
54
58
  require 'swaggy_jenkins'
55
59
  # setup authorization
56
60
  SwaggyJenkinsClient.configure do |config|
@@ -60,28 +64,43 @@ SwaggyJenkinsClient.configure do |config|
60
64
  end
61
65
 
62
66
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
67
+ organization = 'organization_example' # String | Name of the organization
68
+ pipeline = 'pipeline_example' # String | Name of the pipeline
69
+ queue = 'queue_example' # String | Name of the queue item
63
70
 
64
- organization = "organization_example" # String | Name of the organization
71
+ begin
72
+
73
+ api_instance.delete_pipeline_queue_item(organization, pipeline, queue)
74
+ rescue SwaggyJenkinsClient::ApiError => e
75
+ puts "Error when calling BlueOceanApi->delete_pipeline_queue_item: #{e}"
76
+ end
77
+ ```
65
78
 
66
- pipeline = "pipeline_example" # String | Name of the pipeline
79
+ #### Using the delete_pipeline_queue_item_with_http_info variant
67
80
 
68
- queue = "queue_example" # String | Name of the queue item
81
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
69
82
 
83
+ > <Array(nil, Integer, Hash)> delete_pipeline_queue_item_with_http_info(organization, pipeline, queue)
70
84
 
85
+ ```ruby
71
86
  begin
72
- api_instance.delete_pipeline_queue_item(organization, pipeline, queue)
87
+
88
+ data, status_code, headers = api_instance.delete_pipeline_queue_item_with_http_info(organization, pipeline, queue)
89
+ p status_code # => 2xx
90
+ p headers # => { ... }
91
+ p data # => nil
73
92
  rescue SwaggyJenkinsClient::ApiError => e
74
- puts "Exception when calling BlueOceanApi->delete_pipeline_queue_item: #{e}"
93
+ puts "Error when calling BlueOceanApi->delete_pipeline_queue_item_with_http_info: #{e}"
75
94
  end
76
95
  ```
77
96
 
78
97
  ### Parameters
79
98
 
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 |
99
+ | Name | Type | Description | Notes |
100
+ | ---- | ---- | ----------- | ----- |
101
+ | **organization** | **String** | Name of the organization | |
102
+ | **pipeline** | **String** | Name of the pipeline | |
103
+ | **queue** | **String** | Name of the queue item | |
85
104
 
86
105
  ### Return type
87
106
 
@@ -93,21 +112,22 @@ nil (empty response body)
93
112
 
94
113
  ### HTTP request headers
95
114
 
96
- - **Content-Type**: Not defined
97
- - **Accept**: application/json
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: Not defined
98
117
 
99
118
 
119
+ ## get_authenticated_user
100
120
 
101
- # **get_authenticated_user**
102
- > User get_authenticated_user(organization, )
121
+ > <User> get_authenticated_user(organization)
103
122
 
104
123
 
105
124
 
106
125
  Retrieve authenticated user details for an organization
107
126
 
108
- ### Example
127
+ ### Examples
128
+
109
129
  ```ruby
110
- # load the gem
130
+ require 'time'
111
131
  require 'swaggy_jenkins'
112
132
  # setup authorization
113
133
  SwaggyJenkinsClient.configure do |config|
@@ -117,23 +137,40 @@ SwaggyJenkinsClient.configure do |config|
117
137
  end
118
138
 
119
139
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
140
+ organization = 'organization_example' # String | Name of the organization
120
141
 
121
- organization = "organization_example" # String | Name of the organization
142
+ begin
143
+
144
+ result = api_instance.get_authenticated_user(organization)
145
+ p result
146
+ rescue SwaggyJenkinsClient::ApiError => e
147
+ puts "Error when calling BlueOceanApi->get_authenticated_user: #{e}"
148
+ end
149
+ ```
122
150
 
151
+ #### Using the get_authenticated_user_with_http_info variant
123
152
 
153
+ This returns an Array which contains the response data, status code and headers.
154
+
155
+ > <Array(<User>, Integer, Hash)> get_authenticated_user_with_http_info(organization)
156
+
157
+ ```ruby
124
158
  begin
125
- result = api_instance.get_authenticated_user(organization, )
126
- p result
159
+
160
+ data, status_code, headers = api_instance.get_authenticated_user_with_http_info(organization)
161
+ p status_code # => 2xx
162
+ p headers # => { ... }
163
+ p data # => <User>
127
164
  rescue SwaggyJenkinsClient::ApiError => e
128
- puts "Exception when calling BlueOceanApi->get_authenticated_user: #{e}"
165
+ puts "Error when calling BlueOceanApi->get_authenticated_user_with_http_info: #{e}"
129
166
  end
130
167
  ```
131
168
 
132
169
  ### Parameters
133
170
 
134
- Name | Type | Description | Notes
135
- ------------- | ------------- | ------------- | -------------
136
- **organization** | **String**| Name of the organization |
171
+ | Name | Type | Description | Notes |
172
+ | ---- | ---- | ----------- | ----- |
173
+ | **organization** | **String** | Name of the organization | |
137
174
 
138
175
  ### Return type
139
176
 
@@ -145,21 +182,22 @@ Name | Type | Description | Notes
145
182
 
146
183
  ### HTTP request headers
147
184
 
148
- - **Content-Type**: Not defined
149
- - **Accept**: application/json
185
+ - **Content-Type**: Not defined
186
+ - **Accept**: application/json
150
187
 
151
188
 
189
+ ## get_classes
152
190
 
153
- # **get_classes**
154
191
  > String get_classes(_class)
155
192
 
156
193
 
157
194
 
158
195
  Get a list of class names supported by a given class
159
196
 
160
- ### Example
197
+ ### Examples
198
+
161
199
  ```ruby
162
- # load the gem
200
+ require 'time'
163
201
  require 'swaggy_jenkins'
164
202
  # setup authorization
165
203
  SwaggyJenkinsClient.configure do |config|
@@ -169,23 +207,40 @@ SwaggyJenkinsClient.configure do |config|
169
207
  end
170
208
 
171
209
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
172
-
173
- _class = "_class_example" # String | Name of the class
174
-
210
+ _class = '_class_example' # String | Name of the class
175
211
 
176
212
  begin
213
+
177
214
  result = api_instance.get_classes(_class)
178
215
  p result
179
216
  rescue SwaggyJenkinsClient::ApiError => e
180
- puts "Exception when calling BlueOceanApi->get_classes: #{e}"
217
+ puts "Error when calling BlueOceanApi->get_classes: #{e}"
218
+ end
219
+ ```
220
+
221
+ #### Using the get_classes_with_http_info variant
222
+
223
+ This returns an Array which contains the response data, status code and headers.
224
+
225
+ > <Array(String, Integer, Hash)> get_classes_with_http_info(_class)
226
+
227
+ ```ruby
228
+ begin
229
+
230
+ data, status_code, headers = api_instance.get_classes_with_http_info(_class)
231
+ p status_code # => 2xx
232
+ p headers # => { ... }
233
+ p data # => String
234
+ rescue SwaggyJenkinsClient::ApiError => e
235
+ puts "Error when calling BlueOceanApi->get_classes_with_http_info: #{e}"
181
236
  end
182
237
  ```
183
238
 
184
239
  ### Parameters
185
240
 
186
- Name | Type | Description | Notes
187
- ------------- | ------------- | ------------- | -------------
188
- **_class** | **String**| Name of the class |
241
+ | Name | Type | Description | Notes |
242
+ | ---- | ---- | ----------- | ----- |
243
+ | **_class** | **String** | Name of the class | |
189
244
 
190
245
  ### Return type
191
246
 
@@ -197,21 +252,154 @@ Name | Type | Description | Notes
197
252
 
198
253
  ### HTTP request headers
199
254
 
200
- - **Content-Type**: Not defined
201
- - **Accept**: application/json
255
+ - **Content-Type**: Not defined
256
+ - **Accept**: application/json
257
+
258
+
259
+ ## get_json_web_key
260
+
261
+ > String get_json_web_key(key)
262
+
263
+
264
+
265
+ Retrieve JSON Web Key
266
+
267
+ ### Examples
268
+
269
+ ```ruby
270
+ require 'time'
271
+ require 'swaggy_jenkins'
272
+
273
+ api_instance = SwaggyJenkinsClient::BlueOceanApi.new
274
+ key = 56 # Integer | Key ID received as part of JWT header field kid
275
+
276
+ begin
277
+
278
+ result = api_instance.get_json_web_key(key)
279
+ p result
280
+ rescue SwaggyJenkinsClient::ApiError => e
281
+ puts "Error when calling BlueOceanApi->get_json_web_key: #{e}"
282
+ end
283
+ ```
284
+
285
+ #### Using the get_json_web_key_with_http_info variant
202
286
 
287
+ This returns an Array which contains the response data, status code and headers.
203
288
 
289
+ > <Array(String, Integer, Hash)> get_json_web_key_with_http_info(key)
204
290
 
205
- # **get_organisation**
206
- > Organisation get_organisation(organization, )
291
+ ```ruby
292
+ begin
293
+
294
+ data, status_code, headers = api_instance.get_json_web_key_with_http_info(key)
295
+ p status_code # => 2xx
296
+ p headers # => { ... }
297
+ p data # => String
298
+ rescue SwaggyJenkinsClient::ApiError => e
299
+ puts "Error when calling BlueOceanApi->get_json_web_key_with_http_info: #{e}"
300
+ end
301
+ ```
302
+
303
+ ### Parameters
304
+
305
+ | Name | Type | Description | Notes |
306
+ | ---- | ---- | ----------- | ----- |
307
+ | **key** | **Integer** | Key ID received as part of JWT header field kid | |
308
+
309
+ ### Return type
310
+
311
+ **String**
312
+
313
+ ### Authorization
314
+
315
+ No authorization required
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: Not defined
320
+ - **Accept**: application/json
321
+
322
+
323
+ ## get_json_web_token
324
+
325
+ > String get_json_web_token(opts)
326
+
327
+
328
+
329
+ Retrieve JSON Web Token
330
+
331
+ ### Examples
332
+
333
+ ```ruby
334
+ require 'time'
335
+ require 'swaggy_jenkins'
336
+
337
+ api_instance = SwaggyJenkinsClient::BlueOceanApi.new
338
+ opts = {
339
+ expiry_time_in_mins: 56, # Integer | Token expiry time in minutes, default: 30 minutes
340
+ max_expiry_time_in_mins: 56 # Integer | Maximum token expiry time in minutes, default: 480 minutes
341
+ }
342
+
343
+ begin
344
+
345
+ result = api_instance.get_json_web_token(opts)
346
+ p result
347
+ rescue SwaggyJenkinsClient::ApiError => e
348
+ puts "Error when calling BlueOceanApi->get_json_web_token: #{e}"
349
+ end
350
+ ```
351
+
352
+ #### Using the get_json_web_token_with_http_info variant
353
+
354
+ This returns an Array which contains the response data, status code and headers.
355
+
356
+ > <Array(String, Integer, Hash)> get_json_web_token_with_http_info(opts)
357
+
358
+ ```ruby
359
+ begin
360
+
361
+ data, status_code, headers = api_instance.get_json_web_token_with_http_info(opts)
362
+ p status_code # => 2xx
363
+ p headers # => { ... }
364
+ p data # => String
365
+ rescue SwaggyJenkinsClient::ApiError => e
366
+ puts "Error when calling BlueOceanApi->get_json_web_token_with_http_info: #{e}"
367
+ end
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ | Name | Type | Description | Notes |
373
+ | ---- | ---- | ----------- | ----- |
374
+ | **expiry_time_in_mins** | **Integer** | Token expiry time in minutes, default: 30 minutes | [optional] |
375
+ | **max_expiry_time_in_mins** | **Integer** | Maximum token expiry time in minutes, default: 480 minutes | [optional] |
376
+
377
+ ### Return type
378
+
379
+ **String**
380
+
381
+ ### Authorization
382
+
383
+ No authorization required
384
+
385
+ ### HTTP request headers
386
+
387
+ - **Content-Type**: Not defined
388
+ - **Accept**: application/json
389
+
390
+
391
+ ## get_organisation
392
+
393
+ > <Organisation> get_organisation(organization)
207
394
 
208
395
 
209
396
 
210
397
  Retrieve organization details
211
398
 
212
- ### Example
399
+ ### Examples
400
+
213
401
  ```ruby
214
- # load the gem
402
+ require 'time'
215
403
  require 'swaggy_jenkins'
216
404
  # setup authorization
217
405
  SwaggyJenkinsClient.configure do |config|
@@ -221,23 +409,40 @@ SwaggyJenkinsClient.configure do |config|
221
409
  end
222
410
 
223
411
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
412
+ organization = 'organization_example' # String | Name of the organization
224
413
 
225
- organization = "organization_example" # String | Name of the organization
414
+ begin
415
+
416
+ result = api_instance.get_organisation(organization)
417
+ p result
418
+ rescue SwaggyJenkinsClient::ApiError => e
419
+ puts "Error when calling BlueOceanApi->get_organisation: #{e}"
420
+ end
421
+ ```
422
+
423
+ #### Using the get_organisation_with_http_info variant
424
+
425
+ This returns an Array which contains the response data, status code and headers.
226
426
 
427
+ > <Array(<Organisation>, Integer, Hash)> get_organisation_with_http_info(organization)
227
428
 
429
+ ```ruby
228
430
  begin
229
- result = api_instance.get_organisation(organization, )
230
- p result
431
+
432
+ data, status_code, headers = api_instance.get_organisation_with_http_info(organization)
433
+ p status_code # => 2xx
434
+ p headers # => { ... }
435
+ p data # => <Organisation>
231
436
  rescue SwaggyJenkinsClient::ApiError => e
232
- puts "Exception when calling BlueOceanApi->get_organisation: #{e}"
437
+ puts "Error when calling BlueOceanApi->get_organisation_with_http_info: #{e}"
233
438
  end
234
439
  ```
235
440
 
236
441
  ### Parameters
237
442
 
238
- Name | Type | Description | Notes
239
- ------------- | ------------- | ------------- | -------------
240
- **organization** | **String**| Name of the organization |
443
+ | Name | Type | Description | Notes |
444
+ | ---- | ---- | ----------- | ----- |
445
+ | **organization** | **String** | Name of the organization | |
241
446
 
242
447
  ### Return type
243
448
 
@@ -249,21 +454,22 @@ Name | Type | Description | Notes
249
454
 
250
455
  ### HTTP request headers
251
456
 
252
- - **Content-Type**: Not defined
253
- - **Accept**: application/json
457
+ - **Content-Type**: Not defined
458
+ - **Accept**: application/json
254
459
 
255
460
 
461
+ ## get_organisations
256
462
 
257
- # **get_organisations**
258
- > Organisations get_organisations
463
+ > <Array<Organisation>> get_organisations
259
464
 
260
465
 
261
466
 
262
467
  Retrieve all organizations details
263
468
 
264
- ### Example
469
+ ### Examples
470
+
265
471
  ```ruby
266
- # load the gem
472
+ require 'time'
267
473
  require 'swaggy_jenkins'
268
474
  # setup authorization
269
475
  SwaggyJenkinsClient.configure do |config|
@@ -275,19 +481,39 @@ end
275
481
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
276
482
 
277
483
  begin
484
+
278
485
  result = api_instance.get_organisations
279
486
  p result
280
487
  rescue SwaggyJenkinsClient::ApiError => e
281
- puts "Exception when calling BlueOceanApi->get_organisations: #{e}"
488
+ puts "Error when calling BlueOceanApi->get_organisations: #{e}"
489
+ end
490
+ ```
491
+
492
+ #### Using the get_organisations_with_http_info variant
493
+
494
+ This returns an Array which contains the response data, status code and headers.
495
+
496
+ > <Array(<Array<Organisation>>, Integer, Hash)> get_organisations_with_http_info
497
+
498
+ ```ruby
499
+ begin
500
+
501
+ data, status_code, headers = api_instance.get_organisations_with_http_info
502
+ p status_code # => 2xx
503
+ p headers # => { ... }
504
+ p data # => <Array<Organisation>>
505
+ rescue SwaggyJenkinsClient::ApiError => e
506
+ puts "Error when calling BlueOceanApi->get_organisations_with_http_info: #{e}"
282
507
  end
283
508
  ```
284
509
 
285
510
  ### Parameters
511
+
286
512
  This endpoint does not need any parameter.
287
513
 
288
514
  ### Return type
289
515
 
290
- [**Organisations**](Organisations.md)
516
+ [**Array&lt;Organisation&gt;**](Organisation.md)
291
517
 
292
518
  ### Authorization
293
519
 
@@ -295,21 +521,22 @@ This endpoint does not need any parameter.
295
521
 
296
522
  ### HTTP request headers
297
523
 
298
- - **Content-Type**: Not defined
299
- - **Accept**: application/json
524
+ - **Content-Type**: Not defined
525
+ - **Accept**: application/json
300
526
 
301
527
 
528
+ ## get_pipeline
302
529
 
303
- # **get_pipeline**
304
- > Pipeline get_pipeline(organization, pipeline, )
530
+ > <Pipeline> get_pipeline(organization, pipeline)
305
531
 
306
532
 
307
533
 
308
534
  Retrieve pipeline details for an organization
309
535
 
310
- ### Example
536
+ ### Examples
537
+
311
538
  ```ruby
312
- # load the gem
539
+ require 'time'
313
540
  require 'swaggy_jenkins'
314
541
  # setup authorization
315
542
  SwaggyJenkinsClient.configure do |config|
@@ -319,26 +546,42 @@ SwaggyJenkinsClient.configure do |config|
319
546
  end
320
547
 
321
548
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
549
+ organization = 'organization_example' # String | Name of the organization
550
+ pipeline = 'pipeline_example' # String | Name of the pipeline
322
551
 
323
- organization = "organization_example" # String | Name of the organization
552
+ begin
553
+
554
+ result = api_instance.get_pipeline(organization, pipeline)
555
+ p result
556
+ rescue SwaggyJenkinsClient::ApiError => e
557
+ puts "Error when calling BlueOceanApi->get_pipeline: #{e}"
558
+ end
559
+ ```
560
+
561
+ #### Using the get_pipeline_with_http_info variant
324
562
 
325
- pipeline = "pipeline_example" # String | Name of the pipeline
563
+ This returns an Array which contains the response data, status code and headers.
326
564
 
565
+ > <Array(<Pipeline>, Integer, Hash)> get_pipeline_with_http_info(organization, pipeline)
327
566
 
567
+ ```ruby
328
568
  begin
329
- result = api_instance.get_pipeline(organization, pipeline, )
330
- p result
569
+
570
+ data, status_code, headers = api_instance.get_pipeline_with_http_info(organization, pipeline)
571
+ p status_code # => 2xx
572
+ p headers # => { ... }
573
+ p data # => <Pipeline>
331
574
  rescue SwaggyJenkinsClient::ApiError => e
332
- puts "Exception when calling BlueOceanApi->get_pipeline: #{e}"
575
+ puts "Error when calling BlueOceanApi->get_pipeline_with_http_info: #{e}"
333
576
  end
334
577
  ```
335
578
 
336
579
  ### Parameters
337
580
 
338
- Name | Type | Description | Notes
339
- ------------- | ------------- | ------------- | -------------
340
- **organization** | **String**| Name of the organization |
341
- **pipeline** | **String**| Name of the pipeline |
581
+ | Name | Type | Description | Notes |
582
+ | ---- | ---- | ----------- | ----- |
583
+ | **organization** | **String** | Name of the organization | |
584
+ | **pipeline** | **String** | Name of the pipeline | |
342
585
 
343
586
  ### Return type
344
587
 
@@ -350,21 +593,22 @@ Name | Type | Description | Notes
350
593
 
351
594
  ### HTTP request headers
352
595
 
353
- - **Content-Type**: Not defined
354
- - **Accept**: application/json
596
+ - **Content-Type**: Not defined
597
+ - **Accept**: application/json
355
598
 
356
599
 
600
+ ## get_pipeline_activities
357
601
 
358
- # **get_pipeline_activities**
359
- > PipelineActivities get_pipeline_activities(organization, pipeline, )
602
+ > <Array<PipelineActivity>> get_pipeline_activities(organization, pipeline)
360
603
 
361
604
 
362
605
 
363
606
  Retrieve all activities details for an organization pipeline
364
607
 
365
- ### Example
608
+ ### Examples
609
+
366
610
  ```ruby
367
- # load the gem
611
+ require 'time'
368
612
  require 'swaggy_jenkins'
369
613
  # setup authorization
370
614
  SwaggyJenkinsClient.configure do |config|
@@ -374,30 +618,46 @@ SwaggyJenkinsClient.configure do |config|
374
618
  end
375
619
 
376
620
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
621
+ organization = 'organization_example' # String | Name of the organization
622
+ pipeline = 'pipeline_example' # String | Name of the pipeline
623
+
624
+ begin
625
+
626
+ result = api_instance.get_pipeline_activities(organization, pipeline)
627
+ p result
628
+ rescue SwaggyJenkinsClient::ApiError => e
629
+ puts "Error when calling BlueOceanApi->get_pipeline_activities: #{e}"
630
+ end
631
+ ```
377
632
 
378
- organization = "organization_example" # String | Name of the organization
633
+ #### Using the get_pipeline_activities_with_http_info variant
379
634
 
380
- pipeline = "pipeline_example" # String | Name of the pipeline
635
+ This returns an Array which contains the response data, status code and headers.
381
636
 
637
+ > <Array(<Array<PipelineActivity>>, Integer, Hash)> get_pipeline_activities_with_http_info(organization, pipeline)
382
638
 
639
+ ```ruby
383
640
  begin
384
- result = api_instance.get_pipeline_activities(organization, pipeline, )
385
- p result
641
+
642
+ data, status_code, headers = api_instance.get_pipeline_activities_with_http_info(organization, pipeline)
643
+ p status_code # => 2xx
644
+ p headers # => { ... }
645
+ p data # => <Array<PipelineActivity>>
386
646
  rescue SwaggyJenkinsClient::ApiError => e
387
- puts "Exception when calling BlueOceanApi->get_pipeline_activities: #{e}"
647
+ puts "Error when calling BlueOceanApi->get_pipeline_activities_with_http_info: #{e}"
388
648
  end
389
649
  ```
390
650
 
391
651
  ### Parameters
392
652
 
393
- Name | Type | Description | Notes
394
- ------------- | ------------- | ------------- | -------------
395
- **organization** | **String**| Name of the organization |
396
- **pipeline** | **String**| Name of the pipeline |
653
+ | Name | Type | Description | Notes |
654
+ | ---- | ---- | ----------- | ----- |
655
+ | **organization** | **String** | Name of the organization | |
656
+ | **pipeline** | **String** | Name of the pipeline | |
397
657
 
398
658
  ### Return type
399
659
 
400
- [**PipelineActivities**](PipelineActivities.md)
660
+ [**Array&lt;PipelineActivity&gt;**](PipelineActivity.md)
401
661
 
402
662
  ### Authorization
403
663
 
@@ -405,21 +665,22 @@ Name | Type | Description | Notes
405
665
 
406
666
  ### HTTP request headers
407
667
 
408
- - **Content-Type**: Not defined
409
- - **Accept**: application/json
668
+ - **Content-Type**: Not defined
669
+ - **Accept**: application/json
410
670
 
411
671
 
672
+ ## get_pipeline_branch
412
673
 
413
- # **get_pipeline_branch**
414
- > BranchImpl get_pipeline_branch(organization, pipeline, branch, )
674
+ > <BranchImpl> get_pipeline_branch(organization, pipeline, branch)
415
675
 
416
676
 
417
677
 
418
678
  Retrieve branch details for an organization pipeline
419
679
 
420
- ### Example
680
+ ### Examples
681
+
421
682
  ```ruby
422
- # load the gem
683
+ require 'time'
423
684
  require 'swaggy_jenkins'
424
685
  # setup authorization
425
686
  SwaggyJenkinsClient.configure do |config|
@@ -429,29 +690,44 @@ SwaggyJenkinsClient.configure do |config|
429
690
  end
430
691
 
431
692
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
693
+ organization = 'organization_example' # String | Name of the organization
694
+ pipeline = 'pipeline_example' # String | Name of the pipeline
695
+ branch = 'branch_example' # String | Name of the branch
432
696
 
433
- organization = "organization_example" # String | Name of the organization
697
+ begin
698
+
699
+ result = api_instance.get_pipeline_branch(organization, pipeline, branch)
700
+ p result
701
+ rescue SwaggyJenkinsClient::ApiError => e
702
+ puts "Error when calling BlueOceanApi->get_pipeline_branch: #{e}"
703
+ end
704
+ ```
434
705
 
435
- pipeline = "pipeline_example" # String | Name of the pipeline
706
+ #### Using the get_pipeline_branch_with_http_info variant
436
707
 
437
- branch = "branch_example" # String | Name of the branch
708
+ This returns an Array which contains the response data, status code and headers.
438
709
 
710
+ > <Array(<BranchImpl>, Integer, Hash)> get_pipeline_branch_with_http_info(organization, pipeline, branch)
439
711
 
712
+ ```ruby
440
713
  begin
441
- result = api_instance.get_pipeline_branch(organization, pipeline, branch, )
442
- p result
714
+
715
+ data, status_code, headers = api_instance.get_pipeline_branch_with_http_info(organization, pipeline, branch)
716
+ p status_code # => 2xx
717
+ p headers # => { ... }
718
+ p data # => <BranchImpl>
443
719
  rescue SwaggyJenkinsClient::ApiError => e
444
- puts "Exception when calling BlueOceanApi->get_pipeline_branch: #{e}"
720
+ puts "Error when calling BlueOceanApi->get_pipeline_branch_with_http_info: #{e}"
445
721
  end
446
722
  ```
447
723
 
448
724
  ### Parameters
449
725
 
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 |
726
+ | Name | Type | Description | Notes |
727
+ | ---- | ---- | ----------- | ----- |
728
+ | **organization** | **String** | Name of the organization | |
729
+ | **pipeline** | **String** | Name of the pipeline | |
730
+ | **branch** | **String** | Name of the branch | |
455
731
 
456
732
  ### Return type
457
733
 
@@ -463,21 +739,22 @@ Name | Type | Description | Notes
463
739
 
464
740
  ### HTTP request headers
465
741
 
466
- - **Content-Type**: Not defined
467
- - **Accept**: application/json
742
+ - **Content-Type**: Not defined
743
+ - **Accept**: application/json
468
744
 
469
745
 
746
+ ## get_pipeline_branch_run
470
747
 
471
- # **get_pipeline_branch_run**
472
- > PipelineRun get_pipeline_branch_run(organization, pipeline, branch, run)
748
+ > <PipelineRun> get_pipeline_branch_run(organization, pipeline, branch, run)
473
749
 
474
750
 
475
751
 
476
752
  Retrieve branch run details for an organization pipeline
477
753
 
478
- ### Example
754
+ ### Examples
755
+
479
756
  ```ruby
480
- # load the gem
757
+ require 'time'
481
758
  require 'swaggy_jenkins'
482
759
  # setup authorization
483
760
  SwaggyJenkinsClient.configure do |config|
@@ -487,32 +764,46 @@ SwaggyJenkinsClient.configure do |config|
487
764
  end
488
765
 
489
766
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
767
+ organization = 'organization_example' # String | Name of the organization
768
+ pipeline = 'pipeline_example' # String | Name of the pipeline
769
+ branch = 'branch_example' # String | Name of the branch
770
+ run = 'run_example' # String | Name of the run
490
771
 
491
- organization = "organization_example" # String | Name of the organization
492
-
493
- pipeline = "pipeline_example" # String | Name of the pipeline
772
+ begin
773
+
774
+ result = api_instance.get_pipeline_branch_run(organization, pipeline, branch, run)
775
+ p result
776
+ rescue SwaggyJenkinsClient::ApiError => e
777
+ puts "Error when calling BlueOceanApi->get_pipeline_branch_run: #{e}"
778
+ end
779
+ ```
494
780
 
495
- branch = "branch_example" # String | Name of the branch
781
+ #### Using the get_pipeline_branch_run_with_http_info variant
496
782
 
497
- run = "run_example" # String | Name of the run
783
+ This returns an Array which contains the response data, status code and headers.
498
784
 
785
+ > <Array(<PipelineRun>, Integer, Hash)> get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run)
499
786
 
787
+ ```ruby
500
788
  begin
501
- result = api_instance.get_pipeline_branch_run(organization, pipeline, branch, run)
502
- p result
789
+
790
+ data, status_code, headers = api_instance.get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run)
791
+ p status_code # => 2xx
792
+ p headers # => { ... }
793
+ p data # => <PipelineRun>
503
794
  rescue SwaggyJenkinsClient::ApiError => e
504
- puts "Exception when calling BlueOceanApi->get_pipeline_branch_run: #{e}"
795
+ puts "Error when calling BlueOceanApi->get_pipeline_branch_run_with_http_info: #{e}"
505
796
  end
506
797
  ```
507
798
 
508
799
  ### Parameters
509
800
 
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 |
801
+ | Name | Type | Description | Notes |
802
+ | ---- | ---- | ----------- | ----- |
803
+ | **organization** | **String** | Name of the organization | |
804
+ | **pipeline** | **String** | Name of the pipeline | |
805
+ | **branch** | **String** | Name of the branch | |
806
+ | **run** | **String** | Name of the run | |
516
807
 
517
808
  ### Return type
518
809
 
@@ -524,21 +815,22 @@ Name | Type | Description | Notes
524
815
 
525
816
  ### HTTP request headers
526
817
 
527
- - **Content-Type**: Not defined
528
- - **Accept**: application/json
818
+ - **Content-Type**: Not defined
819
+ - **Accept**: application/json
529
820
 
530
821
 
822
+ ## get_pipeline_branches
531
823
 
532
- # **get_pipeline_branches**
533
- > MultibranchPipeline get_pipeline_branches(organization, pipeline, )
824
+ > <MultibranchPipeline> get_pipeline_branches(organization, pipeline)
534
825
 
535
826
 
536
827
 
537
828
  Retrieve all branches details for an organization pipeline
538
829
 
539
- ### Example
830
+ ### Examples
831
+
540
832
  ```ruby
541
- # load the gem
833
+ require 'time'
542
834
  require 'swaggy_jenkins'
543
835
  # setup authorization
544
836
  SwaggyJenkinsClient.configure do |config|
@@ -548,26 +840,42 @@ SwaggyJenkinsClient.configure do |config|
548
840
  end
549
841
 
550
842
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
843
+ organization = 'organization_example' # String | Name of the organization
844
+ pipeline = 'pipeline_example' # String | Name of the pipeline
845
+
846
+ begin
847
+
848
+ result = api_instance.get_pipeline_branches(organization, pipeline)
849
+ p result
850
+ rescue SwaggyJenkinsClient::ApiError => e
851
+ puts "Error when calling BlueOceanApi->get_pipeline_branches: #{e}"
852
+ end
853
+ ```
551
854
 
552
- organization = "organization_example" # String | Name of the organization
855
+ #### Using the get_pipeline_branches_with_http_info variant
553
856
 
554
- pipeline = "pipeline_example" # String | Name of the pipeline
857
+ This returns an Array which contains the response data, status code and headers.
555
858
 
859
+ > <Array(<MultibranchPipeline>, Integer, Hash)> get_pipeline_branches_with_http_info(organization, pipeline)
556
860
 
861
+ ```ruby
557
862
  begin
558
- result = api_instance.get_pipeline_branches(organization, pipeline, )
559
- p result
863
+
864
+ data, status_code, headers = api_instance.get_pipeline_branches_with_http_info(organization, pipeline)
865
+ p status_code # => 2xx
866
+ p headers # => { ... }
867
+ p data # => <MultibranchPipeline>
560
868
  rescue SwaggyJenkinsClient::ApiError => e
561
- puts "Exception when calling BlueOceanApi->get_pipeline_branches: #{e}"
869
+ puts "Error when calling BlueOceanApi->get_pipeline_branches_with_http_info: #{e}"
562
870
  end
563
871
  ```
564
872
 
565
873
  ### Parameters
566
874
 
567
- Name | Type | Description | Notes
568
- ------------- | ------------- | ------------- | -------------
569
- **organization** | **String**| Name of the organization |
570
- **pipeline** | **String**| Name of the pipeline |
875
+ | Name | Type | Description | Notes |
876
+ | ---- | ---- | ----------- | ----- |
877
+ | **organization** | **String** | Name of the organization | |
878
+ | **pipeline** | **String** | Name of the pipeline | |
571
879
 
572
880
  ### Return type
573
881
 
@@ -579,21 +887,22 @@ Name | Type | Description | Notes
579
887
 
580
888
  ### HTTP request headers
581
889
 
582
- - **Content-Type**: Not defined
583
- - **Accept**: application/json
890
+ - **Content-Type**: Not defined
891
+ - **Accept**: application/json
584
892
 
585
893
 
894
+ ## get_pipeline_folder
586
895
 
587
- # **get_pipeline_folder**
588
- > PipelineFolderImpl get_pipeline_folder(organization, folder)
896
+ > <PipelineFolderImpl> get_pipeline_folder(organization, folder)
589
897
 
590
898
 
591
899
 
592
900
  Retrieve pipeline folder for an organization
593
901
 
594
- ### Example
902
+ ### Examples
903
+
595
904
  ```ruby
596
- # load the gem
905
+ require 'time'
597
906
  require 'swaggy_jenkins'
598
907
  # setup authorization
599
908
  SwaggyJenkinsClient.configure do |config|
@@ -603,26 +912,42 @@ SwaggyJenkinsClient.configure do |config|
603
912
  end
604
913
 
605
914
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
915
+ organization = 'organization_example' # String | Name of the organization
916
+ folder = 'folder_example' # String | Name of the folder
917
+
918
+ begin
919
+
920
+ result = api_instance.get_pipeline_folder(organization, folder)
921
+ p result
922
+ rescue SwaggyJenkinsClient::ApiError => e
923
+ puts "Error when calling BlueOceanApi->get_pipeline_folder: #{e}"
924
+ end
925
+ ```
606
926
 
607
- organization = "organization_example" # String | Name of the organization
927
+ #### Using the get_pipeline_folder_with_http_info variant
608
928
 
609
- folder = "folder_example" # String | Name of the folder
929
+ This returns an Array which contains the response data, status code and headers.
610
930
 
931
+ > <Array(<PipelineFolderImpl>, Integer, Hash)> get_pipeline_folder_with_http_info(organization, folder)
611
932
 
933
+ ```ruby
612
934
  begin
613
- result = api_instance.get_pipeline_folder(organization, folder)
614
- p result
935
+
936
+ data, status_code, headers = api_instance.get_pipeline_folder_with_http_info(organization, folder)
937
+ p status_code # => 2xx
938
+ p headers # => { ... }
939
+ p data # => <PipelineFolderImpl>
615
940
  rescue SwaggyJenkinsClient::ApiError => e
616
- puts "Exception when calling BlueOceanApi->get_pipeline_folder: #{e}"
941
+ puts "Error when calling BlueOceanApi->get_pipeline_folder_with_http_info: #{e}"
617
942
  end
618
943
  ```
619
944
 
620
945
  ### Parameters
621
946
 
622
- Name | Type | Description | Notes
623
- ------------- | ------------- | ------------- | -------------
624
- **organization** | **String**| Name of the organization |
625
- **folder** | **String**| Name of the folder |
947
+ | Name | Type | Description | Notes |
948
+ | ---- | ---- | ----------- | ----- |
949
+ | **organization** | **String** | Name of the organization | |
950
+ | **folder** | **String** | Name of the folder | |
626
951
 
627
952
  ### Return type
628
953
 
@@ -634,21 +959,22 @@ Name | Type | Description | Notes
634
959
 
635
960
  ### HTTP request headers
636
961
 
637
- - **Content-Type**: Not defined
638
- - **Accept**: application/json
962
+ - **Content-Type**: Not defined
963
+ - **Accept**: application/json
639
964
 
640
965
 
966
+ ## get_pipeline_folder_pipeline
641
967
 
642
- # **get_pipeline_folder_pipeline**
643
- > PipelineImpl get_pipeline_folder_pipeline(organization, pipeline, folder)
968
+ > <PipelineImpl> get_pipeline_folder_pipeline(organization, pipeline, folder)
644
969
 
645
970
 
646
971
 
647
972
  Retrieve pipeline details for an organization folder
648
973
 
649
- ### Example
974
+ ### Examples
975
+
650
976
  ```ruby
651
- # load the gem
977
+ require 'time'
652
978
  require 'swaggy_jenkins'
653
979
  # setup authorization
654
980
  SwaggyJenkinsClient.configure do |config|
@@ -658,29 +984,44 @@ SwaggyJenkinsClient.configure do |config|
658
984
  end
659
985
 
660
986
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
987
+ organization = 'organization_example' # String | Name of the organization
988
+ pipeline = 'pipeline_example' # String | Name of the pipeline
989
+ folder = 'folder_example' # String | Name of the folder
661
990
 
662
- organization = "organization_example" # String | Name of the organization
991
+ begin
992
+
993
+ result = api_instance.get_pipeline_folder_pipeline(organization, pipeline, folder)
994
+ p result
995
+ rescue SwaggyJenkinsClient::ApiError => e
996
+ puts "Error when calling BlueOceanApi->get_pipeline_folder_pipeline: #{e}"
997
+ end
998
+ ```
663
999
 
664
- pipeline = "pipeline_example" # String | Name of the pipeline
1000
+ #### Using the get_pipeline_folder_pipeline_with_http_info variant
665
1001
 
666
- folder = "folder_example" # String | Name of the folder
1002
+ This returns an Array which contains the response data, status code and headers.
667
1003
 
1004
+ > <Array(<PipelineImpl>, Integer, Hash)> get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder)
668
1005
 
1006
+ ```ruby
669
1007
  begin
670
- result = api_instance.get_pipeline_folder_pipeline(organization, pipeline, folder)
671
- p result
1008
+
1009
+ data, status_code, headers = api_instance.get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder)
1010
+ p status_code # => 2xx
1011
+ p headers # => { ... }
1012
+ p data # => <PipelineImpl>
672
1013
  rescue SwaggyJenkinsClient::ApiError => e
673
- puts "Exception when calling BlueOceanApi->get_pipeline_folder_pipeline: #{e}"
1014
+ puts "Error when calling BlueOceanApi->get_pipeline_folder_pipeline_with_http_info: #{e}"
674
1015
  end
675
1016
  ```
676
1017
 
677
1018
  ### Parameters
678
1019
 
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 |
1020
+ | Name | Type | Description | Notes |
1021
+ | ---- | ---- | ----------- | ----- |
1022
+ | **organization** | **String** | Name of the organization | |
1023
+ | **pipeline** | **String** | Name of the pipeline | |
1024
+ | **folder** | **String** | Name of the folder | |
684
1025
 
685
1026
  ### Return type
686
1027
 
@@ -692,21 +1033,22 @@ Name | Type | Description | Notes
692
1033
 
693
1034
  ### HTTP request headers
694
1035
 
695
- - **Content-Type**: Not defined
696
- - **Accept**: application/json
1036
+ - **Content-Type**: Not defined
1037
+ - **Accept**: application/json
697
1038
 
698
1039
 
1040
+ ## get_pipeline_queue
699
1041
 
700
- # **get_pipeline_queue**
701
- > PipelineQueue get_pipeline_queue(organization, pipeline, )
1042
+ > <Array<QueueItemImpl>> get_pipeline_queue(organization, pipeline)
702
1043
 
703
1044
 
704
1045
 
705
1046
  Retrieve queue details for an organization pipeline
706
1047
 
707
- ### Example
1048
+ ### Examples
1049
+
708
1050
  ```ruby
709
- # load the gem
1051
+ require 'time'
710
1052
  require 'swaggy_jenkins'
711
1053
  # setup authorization
712
1054
  SwaggyJenkinsClient.configure do |config|
@@ -716,30 +1058,46 @@ SwaggyJenkinsClient.configure do |config|
716
1058
  end
717
1059
 
718
1060
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1061
+ organization = 'organization_example' # String | Name of the organization
1062
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1063
+
1064
+ begin
1065
+
1066
+ result = api_instance.get_pipeline_queue(organization, pipeline)
1067
+ p result
1068
+ rescue SwaggyJenkinsClient::ApiError => e
1069
+ puts "Error when calling BlueOceanApi->get_pipeline_queue: #{e}"
1070
+ end
1071
+ ```
719
1072
 
720
- organization = "organization_example" # String | Name of the organization
1073
+ #### Using the get_pipeline_queue_with_http_info variant
721
1074
 
722
- pipeline = "pipeline_example" # String | Name of the pipeline
1075
+ This returns an Array which contains the response data, status code and headers.
723
1076
 
1077
+ > <Array(<Array<QueueItemImpl>>, Integer, Hash)> get_pipeline_queue_with_http_info(organization, pipeline)
724
1078
 
1079
+ ```ruby
725
1080
  begin
726
- result = api_instance.get_pipeline_queue(organization, pipeline, )
727
- p result
1081
+
1082
+ data, status_code, headers = api_instance.get_pipeline_queue_with_http_info(organization, pipeline)
1083
+ p status_code # => 2xx
1084
+ p headers # => { ... }
1085
+ p data # => <Array<QueueItemImpl>>
728
1086
  rescue SwaggyJenkinsClient::ApiError => e
729
- puts "Exception when calling BlueOceanApi->get_pipeline_queue: #{e}"
1087
+ puts "Error when calling BlueOceanApi->get_pipeline_queue_with_http_info: #{e}"
730
1088
  end
731
1089
  ```
732
1090
 
733
1091
  ### Parameters
734
1092
 
735
- Name | Type | Description | Notes
736
- ------------- | ------------- | ------------- | -------------
737
- **organization** | **String**| Name of the organization |
738
- **pipeline** | **String**| Name of the pipeline |
1093
+ | Name | Type | Description | Notes |
1094
+ | ---- | ---- | ----------- | ----- |
1095
+ | **organization** | **String** | Name of the organization | |
1096
+ | **pipeline** | **String** | Name of the pipeline | |
739
1097
 
740
1098
  ### Return type
741
1099
 
742
- [**PipelineQueue**](PipelineQueue.md)
1100
+ [**Array&lt;QueueItemImpl&gt;**](QueueItemImpl.md)
743
1101
 
744
1102
  ### Authorization
745
1103
 
@@ -747,21 +1105,22 @@ Name | Type | Description | Notes
747
1105
 
748
1106
  ### HTTP request headers
749
1107
 
750
- - **Content-Type**: Not defined
751
- - **Accept**: application/json
1108
+ - **Content-Type**: Not defined
1109
+ - **Accept**: application/json
752
1110
 
753
1111
 
1112
+ ## get_pipeline_run
754
1113
 
755
- # **get_pipeline_run**
756
- > PipelineRun get_pipeline_run(organization, pipeline, run)
1114
+ > <PipelineRun> get_pipeline_run(organization, pipeline, run)
757
1115
 
758
1116
 
759
1117
 
760
1118
  Retrieve run details for an organization pipeline
761
1119
 
762
- ### Example
1120
+ ### Examples
1121
+
763
1122
  ```ruby
764
- # load the gem
1123
+ require 'time'
765
1124
  require 'swaggy_jenkins'
766
1125
  # setup authorization
767
1126
  SwaggyJenkinsClient.configure do |config|
@@ -771,29 +1130,44 @@ SwaggyJenkinsClient.configure do |config|
771
1130
  end
772
1131
 
773
1132
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1133
+ organization = 'organization_example' # String | Name of the organization
1134
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1135
+ run = 'run_example' # String | Name of the run
774
1136
 
775
- organization = "organization_example" # String | Name of the organization
1137
+ begin
1138
+
1139
+ result = api_instance.get_pipeline_run(organization, pipeline, run)
1140
+ p result
1141
+ rescue SwaggyJenkinsClient::ApiError => e
1142
+ puts "Error when calling BlueOceanApi->get_pipeline_run: #{e}"
1143
+ end
1144
+ ```
776
1145
 
777
- pipeline = "pipeline_example" # String | Name of the pipeline
1146
+ #### Using the get_pipeline_run_with_http_info variant
778
1147
 
779
- run = "run_example" # String | Name of the run
1148
+ This returns an Array which contains the response data, status code and headers.
780
1149
 
1150
+ > <Array(<PipelineRun>, Integer, Hash)> get_pipeline_run_with_http_info(organization, pipeline, run)
781
1151
 
1152
+ ```ruby
782
1153
  begin
783
- result = api_instance.get_pipeline_run(organization, pipeline, run)
784
- p result
1154
+
1155
+ data, status_code, headers = api_instance.get_pipeline_run_with_http_info(organization, pipeline, run)
1156
+ p status_code # => 2xx
1157
+ p headers # => { ... }
1158
+ p data # => <PipelineRun>
785
1159
  rescue SwaggyJenkinsClient::ApiError => e
786
- puts "Exception when calling BlueOceanApi->get_pipeline_run: #{e}"
1160
+ puts "Error when calling BlueOceanApi->get_pipeline_run_with_http_info: #{e}"
787
1161
  end
788
1162
  ```
789
1163
 
790
1164
  ### Parameters
791
1165
 
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 |
1166
+ | Name | Type | Description | Notes |
1167
+ | ---- | ---- | ----------- | ----- |
1168
+ | **organization** | **String** | Name of the organization | |
1169
+ | **pipeline** | **String** | Name of the pipeline | |
1170
+ | **run** | **String** | Name of the run | |
797
1171
 
798
1172
  ### Return type
799
1173
 
@@ -805,21 +1179,22 @@ Name | Type | Description | Notes
805
1179
 
806
1180
  ### HTTP request headers
807
1181
 
808
- - **Content-Type**: Not defined
809
- - **Accept**: application/json
1182
+ - **Content-Type**: Not defined
1183
+ - **Accept**: application/json
810
1184
 
811
1185
 
1186
+ ## get_pipeline_run_log
812
1187
 
813
- # **get_pipeline_run_log**
814
1188
  > String get_pipeline_run_log(organization, pipeline, run, opts)
815
1189
 
816
1190
 
817
1191
 
818
1192
  Get log for a pipeline run
819
1193
 
820
- ### Example
1194
+ ### Examples
1195
+
821
1196
  ```ruby
822
- # load the gem
1197
+ require 'time'
823
1198
  require 'swaggy_jenkins'
824
1199
  # setup authorization
825
1200
  SwaggyJenkinsClient.configure do |config|
@@ -829,35 +1204,50 @@ SwaggyJenkinsClient.configure do |config|
829
1204
  end
830
1205
 
831
1206
  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 = {
1207
+ organization = 'organization_example' # String | Name of the organization
1208
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1209
+ run = 'run_example' # String | Name of the run
1210
+ opts = {
840
1211
  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
1212
+ download: true # Boolean | Set to true in order to download the file, otherwise it's passed as a response body
842
1213
  }
843
1214
 
844
1215
  begin
1216
+
845
1217
  result = api_instance.get_pipeline_run_log(organization, pipeline, run, opts)
846
1218
  p result
847
1219
  rescue SwaggyJenkinsClient::ApiError => e
848
- puts "Exception when calling BlueOceanApi->get_pipeline_run_log: #{e}"
1220
+ puts "Error when calling BlueOceanApi->get_pipeline_run_log: #{e}"
1221
+ end
1222
+ ```
1223
+
1224
+ #### Using the get_pipeline_run_log_with_http_info variant
1225
+
1226
+ This returns an Array which contains the response data, status code and headers.
1227
+
1228
+ > <Array(String, Integer, Hash)> get_pipeline_run_log_with_http_info(organization, pipeline, run, opts)
1229
+
1230
+ ```ruby
1231
+ begin
1232
+
1233
+ data, status_code, headers = api_instance.get_pipeline_run_log_with_http_info(organization, pipeline, run, opts)
1234
+ p status_code # => 2xx
1235
+ p headers # => { ... }
1236
+ p data # => String
1237
+ rescue SwaggyJenkinsClient::ApiError => e
1238
+ puts "Error when calling BlueOceanApi->get_pipeline_run_log_with_http_info: #{e}"
849
1239
  end
850
1240
  ```
851
1241
 
852
1242
  ### Parameters
853
1243
 
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&#39;s passed as a response body | [optional]
1244
+ | Name | Type | Description | Notes |
1245
+ | ---- | ---- | ----------- | ----- |
1246
+ | **organization** | **String** | Name of the organization | |
1247
+ | **pipeline** | **String** | Name of the pipeline | |
1248
+ | **run** | **String** | Name of the run | |
1249
+ | **start** | **Integer** | Start position of the log | [optional] |
1250
+ | **download** | **Boolean** | Set to true in order to download the file, otherwise it&#39;s passed as a response body | [optional] |
861
1251
 
862
1252
  ### Return type
863
1253
 
@@ -869,21 +1259,22 @@ Name | Type | Description | Notes
869
1259
 
870
1260
  ### HTTP request headers
871
1261
 
872
- - **Content-Type**: Not defined
873
- - **Accept**: application/json
1262
+ - **Content-Type**: Not defined
1263
+ - **Accept**: application/json
874
1264
 
875
1265
 
1266
+ ## get_pipeline_run_node
876
1267
 
877
- # **get_pipeline_run_node**
878
- > PipelineRunNode get_pipeline_run_node(organization, pipeline, runnode, )
1268
+ > <PipelineRunNode> get_pipeline_run_node(organization, pipeline, run, node)
879
1269
 
880
1270
 
881
1271
 
882
1272
  Retrieve run node details for an organization pipeline
883
1273
 
884
- ### Example
1274
+ ### Examples
1275
+
885
1276
  ```ruby
886
- # load the gem
1277
+ require 'time'
887
1278
  require 'swaggy_jenkins'
888
1279
  # setup authorization
889
1280
  SwaggyJenkinsClient.configure do |config|
@@ -893,32 +1284,46 @@ SwaggyJenkinsClient.configure do |config|
893
1284
  end
894
1285
 
895
1286
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1287
+ organization = 'organization_example' # String | Name of the organization
1288
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1289
+ run = 'run_example' # String | Name of the run
1290
+ node = 'node_example' # String | Name of the node
896
1291
 
897
- organization = "organization_example" # String | Name of the organization
898
-
899
- pipeline = "pipeline_example" # String | Name of the pipeline
1292
+ begin
1293
+
1294
+ result = api_instance.get_pipeline_run_node(organization, pipeline, run, node)
1295
+ p result
1296
+ rescue SwaggyJenkinsClient::ApiError => e
1297
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node: #{e}"
1298
+ end
1299
+ ```
900
1300
 
901
- run = "run_example" # String | Name of the run
1301
+ #### Using the get_pipeline_run_node_with_http_info variant
902
1302
 
903
- node = "node_example" # String | Name of the node
1303
+ This returns an Array which contains the response data, status code and headers.
904
1304
 
1305
+ > <Array(<PipelineRunNode>, Integer, Hash)> get_pipeline_run_node_with_http_info(organization, pipeline, run, node)
905
1306
 
1307
+ ```ruby
906
1308
  begin
907
- result = api_instance.get_pipeline_run_node(organization, pipeline, runnode, )
908
- p result
1309
+
1310
+ data, status_code, headers = api_instance.get_pipeline_run_node_with_http_info(organization, pipeline, run, node)
1311
+ p status_code # => 2xx
1312
+ p headers # => { ... }
1313
+ p data # => <PipelineRunNode>
909
1314
  rescue SwaggyJenkinsClient::ApiError => e
910
- puts "Exception when calling BlueOceanApi->get_pipeline_run_node: #{e}"
1315
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_with_http_info: #{e}"
911
1316
  end
912
1317
  ```
913
1318
 
914
1319
  ### Parameters
915
1320
 
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 |
1321
+ | Name | Type | Description | Notes |
1322
+ | ---- | ---- | ----------- | ----- |
1323
+ | **organization** | **String** | Name of the organization | |
1324
+ | **pipeline** | **String** | Name of the pipeline | |
1325
+ | **run** | **String** | Name of the run | |
1326
+ | **node** | **String** | Name of the node | |
922
1327
 
923
1328
  ### Return type
924
1329
 
@@ -930,21 +1335,22 @@ Name | Type | Description | Notes
930
1335
 
931
1336
  ### HTTP request headers
932
1337
 
933
- - **Content-Type**: Not defined
934
- - **Accept**: application/json
1338
+ - **Content-Type**: Not defined
1339
+ - **Accept**: application/json
935
1340
 
936
1341
 
1342
+ ## get_pipeline_run_node_step
937
1343
 
938
- # **get_pipeline_run_node_step**
939
- > PipelineStepImpl get_pipeline_run_node_step(organization, pipeline, runnode, step)
1344
+ > <PipelineStepImpl> get_pipeline_run_node_step(organization, pipeline, run, node, step)
940
1345
 
941
1346
 
942
1347
 
943
1348
  Retrieve run node details for an organization pipeline
944
1349
 
945
- ### Example
1350
+ ### Examples
1351
+
946
1352
  ```ruby
947
- # load the gem
1353
+ require 'time'
948
1354
  require 'swaggy_jenkins'
949
1355
  # setup authorization
950
1356
  SwaggyJenkinsClient.configure do |config|
@@ -954,35 +1360,48 @@ SwaggyJenkinsClient.configure do |config|
954
1360
  end
955
1361
 
956
1362
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1363
+ organization = 'organization_example' # String | Name of the organization
1364
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1365
+ run = 'run_example' # String | Name of the run
1366
+ node = 'node_example' # String | Name of the node
1367
+ step = 'step_example' # String | Name of the step
957
1368
 
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
1369
+ begin
1370
+
1371
+ result = api_instance.get_pipeline_run_node_step(organization, pipeline, run, node, step)
1372
+ p result
1373
+ rescue SwaggyJenkinsClient::ApiError => e
1374
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_step: #{e}"
1375
+ end
1376
+ ```
963
1377
 
964
- node = "node_example" # String | Name of the node
1378
+ #### Using the get_pipeline_run_node_step_with_http_info variant
965
1379
 
966
- step = "step_example" # String | Name of the step
1380
+ This returns an Array which contains the response data, status code and headers.
967
1381
 
1382
+ > <Array(<PipelineStepImpl>, Integer, Hash)> get_pipeline_run_node_step_with_http_info(organization, pipeline, run, node, step)
968
1383
 
1384
+ ```ruby
969
1385
  begin
970
- result = api_instance.get_pipeline_run_node_step(organization, pipeline, runnode, step)
971
- p result
1386
+
1387
+ data, status_code, headers = api_instance.get_pipeline_run_node_step_with_http_info(organization, pipeline, run, node, step)
1388
+ p status_code # => 2xx
1389
+ p headers # => { ... }
1390
+ p data # => <PipelineStepImpl>
972
1391
  rescue SwaggyJenkinsClient::ApiError => e
973
- puts "Exception when calling BlueOceanApi->get_pipeline_run_node_step: #{e}"
1392
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_step_with_http_info: #{e}"
974
1393
  end
975
1394
  ```
976
1395
 
977
1396
  ### Parameters
978
1397
 
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 |
1398
+ | Name | Type | Description | Notes |
1399
+ | ---- | ---- | ----------- | ----- |
1400
+ | **organization** | **String** | Name of the organization | |
1401
+ | **pipeline** | **String** | Name of the pipeline | |
1402
+ | **run** | **String** | Name of the run | |
1403
+ | **node** | **String** | Name of the node | |
1404
+ | **step** | **String** | Name of the step | |
986
1405
 
987
1406
  ### Return type
988
1407
 
@@ -994,21 +1413,22 @@ Name | Type | Description | Notes
994
1413
 
995
1414
  ### HTTP request headers
996
1415
 
997
- - **Content-Type**: Not defined
998
- - **Accept**: application/json
1416
+ - **Content-Type**: Not defined
1417
+ - **Accept**: application/json
999
1418
 
1000
1419
 
1420
+ ## get_pipeline_run_node_step_log
1001
1421
 
1002
- # **get_pipeline_run_node_step_log**
1003
- > String get_pipeline_run_node_step_log(organization, pipeline, runnode, step)
1422
+ > String get_pipeline_run_node_step_log(organization, pipeline, run, node, step)
1004
1423
 
1005
1424
 
1006
1425
 
1007
1426
  Get log for a pipeline run node step
1008
1427
 
1009
- ### Example
1428
+ ### Examples
1429
+
1010
1430
  ```ruby
1011
- # load the gem
1431
+ require 'time'
1012
1432
  require 'swaggy_jenkins'
1013
1433
  # setup authorization
1014
1434
  SwaggyJenkinsClient.configure do |config|
@@ -1018,35 +1438,48 @@ SwaggyJenkinsClient.configure do |config|
1018
1438
  end
1019
1439
 
1020
1440
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1441
+ organization = 'organization_example' # String | Name of the organization
1442
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1443
+ run = 'run_example' # String | Name of the run
1444
+ node = 'node_example' # String | Name of the node
1445
+ step = 'step_example' # String | Name of the step
1021
1446
 
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
1447
+ begin
1448
+
1449
+ result = api_instance.get_pipeline_run_node_step_log(organization, pipeline, run, node, step)
1450
+ p result
1451
+ rescue SwaggyJenkinsClient::ApiError => e
1452
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_step_log: #{e}"
1453
+ end
1454
+ ```
1027
1455
 
1028
- node = "node_example" # String | Name of the node
1456
+ #### Using the get_pipeline_run_node_step_log_with_http_info variant
1029
1457
 
1030
- step = "step_example" # String | Name of the step
1458
+ This returns an Array which contains the response data, status code and headers.
1031
1459
 
1460
+ > <Array(String, Integer, Hash)> get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step)
1032
1461
 
1462
+ ```ruby
1033
1463
  begin
1034
- result = api_instance.get_pipeline_run_node_step_log(organization, pipeline, runnode, step)
1035
- p result
1464
+
1465
+ data, status_code, headers = api_instance.get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step)
1466
+ p status_code # => 2xx
1467
+ p headers # => { ... }
1468
+ p data # => String
1036
1469
  rescue SwaggyJenkinsClient::ApiError => e
1037
- puts "Exception when calling BlueOceanApi->get_pipeline_run_node_step_log: #{e}"
1470
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_step_log_with_http_info: #{e}"
1038
1471
  end
1039
1472
  ```
1040
1473
 
1041
1474
  ### Parameters
1042
1475
 
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 |
1476
+ | Name | Type | Description | Notes |
1477
+ | ---- | ---- | ----------- | ----- |
1478
+ | **organization** | **String** | Name of the organization | |
1479
+ | **pipeline** | **String** | Name of the pipeline | |
1480
+ | **run** | **String** | Name of the run | |
1481
+ | **node** | **String** | Name of the node | |
1482
+ | **step** | **String** | Name of the step | |
1050
1483
 
1051
1484
  ### Return type
1052
1485
 
@@ -1058,21 +1491,22 @@ Name | Type | Description | Notes
1058
1491
 
1059
1492
  ### HTTP request headers
1060
1493
 
1061
- - **Content-Type**: Not defined
1062
- - **Accept**: application/json
1494
+ - **Content-Type**: Not defined
1495
+ - **Accept**: application/json
1063
1496
 
1064
1497
 
1498
+ ## get_pipeline_run_node_steps
1065
1499
 
1066
- # **get_pipeline_run_node_steps**
1067
- > PipelineRunNodeSteps get_pipeline_run_node_steps(organization, pipeline, runnode, )
1500
+ > <Array<PipelineStepImpl>> get_pipeline_run_node_steps(organization, pipeline, run, node)
1068
1501
 
1069
1502
 
1070
1503
 
1071
1504
  Retrieve run node steps details for an organization pipeline
1072
1505
 
1073
- ### Example
1506
+ ### Examples
1507
+
1074
1508
  ```ruby
1075
- # load the gem
1509
+ require 'time'
1076
1510
  require 'swaggy_jenkins'
1077
1511
  # setup authorization
1078
1512
  SwaggyJenkinsClient.configure do |config|
@@ -1082,36 +1516,50 @@ SwaggyJenkinsClient.configure do |config|
1082
1516
  end
1083
1517
 
1084
1518
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1519
+ organization = 'organization_example' # String | Name of the organization
1520
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1521
+ run = 'run_example' # String | Name of the run
1522
+ node = 'node_example' # String | Name of the node
1085
1523
 
1086
- organization = "organization_example" # String | Name of the organization
1087
-
1088
- pipeline = "pipeline_example" # String | Name of the pipeline
1524
+ begin
1525
+
1526
+ result = api_instance.get_pipeline_run_node_steps(organization, pipeline, run, node)
1527
+ p result
1528
+ rescue SwaggyJenkinsClient::ApiError => e
1529
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_steps: #{e}"
1530
+ end
1531
+ ```
1089
1532
 
1090
- run = "run_example" # String | Name of the run
1533
+ #### Using the get_pipeline_run_node_steps_with_http_info variant
1091
1534
 
1092
- node = "node_example" # String | Name of the node
1535
+ This returns an Array which contains the response data, status code and headers.
1093
1536
 
1537
+ > <Array(<Array<PipelineStepImpl>>, Integer, Hash)> get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node)
1094
1538
 
1539
+ ```ruby
1095
1540
  begin
1096
- result = api_instance.get_pipeline_run_node_steps(organization, pipeline, runnode, )
1097
- p result
1541
+
1542
+ data, status_code, headers = api_instance.get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node)
1543
+ p status_code # => 2xx
1544
+ p headers # => { ... }
1545
+ p data # => <Array<PipelineStepImpl>>
1098
1546
  rescue SwaggyJenkinsClient::ApiError => e
1099
- puts "Exception when calling BlueOceanApi->get_pipeline_run_node_steps: #{e}"
1547
+ puts "Error when calling BlueOceanApi->get_pipeline_run_node_steps_with_http_info: #{e}"
1100
1548
  end
1101
1549
  ```
1102
1550
 
1103
1551
  ### Parameters
1104
1552
 
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 |
1553
+ | Name | Type | Description | Notes |
1554
+ | ---- | ---- | ----------- | ----- |
1555
+ | **organization** | **String** | Name of the organization | |
1556
+ | **pipeline** | **String** | Name of the pipeline | |
1557
+ | **run** | **String** | Name of the run | |
1558
+ | **node** | **String** | Name of the node | |
1111
1559
 
1112
1560
  ### Return type
1113
1561
 
1114
- [**PipelineRunNodeSteps**](PipelineRunNodeSteps.md)
1562
+ [**Array&lt;PipelineStepImpl&gt;**](PipelineStepImpl.md)
1115
1563
 
1116
1564
  ### Authorization
1117
1565
 
@@ -1119,21 +1567,22 @@ Name | Type | Description | Notes
1119
1567
 
1120
1568
  ### HTTP request headers
1121
1569
 
1122
- - **Content-Type**: Not defined
1123
- - **Accept**: application/json
1570
+ - **Content-Type**: Not defined
1571
+ - **Accept**: application/json
1124
1572
 
1125
1573
 
1574
+ ## get_pipeline_run_nodes
1126
1575
 
1127
- # **get_pipeline_run_nodes**
1128
- > PipelineRunNodes get_pipeline_run_nodes(organization, pipeline, run)
1576
+ > <Array<PipelineRunNode>> get_pipeline_run_nodes(organization, pipeline, run)
1129
1577
 
1130
1578
 
1131
1579
 
1132
1580
  Retrieve run nodes details for an organization pipeline
1133
1581
 
1134
- ### Example
1582
+ ### Examples
1583
+
1135
1584
  ```ruby
1136
- # load the gem
1585
+ require 'time'
1137
1586
  require 'swaggy_jenkins'
1138
1587
  # setup authorization
1139
1588
  SwaggyJenkinsClient.configure do |config|
@@ -1143,33 +1592,48 @@ SwaggyJenkinsClient.configure do |config|
1143
1592
  end
1144
1593
 
1145
1594
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1595
+ organization = 'organization_example' # String | Name of the organization
1596
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1597
+ run = 'run_example' # String | Name of the run
1146
1598
 
1147
- organization = "organization_example" # String | Name of the organization
1599
+ begin
1600
+
1601
+ result = api_instance.get_pipeline_run_nodes(organization, pipeline, run)
1602
+ p result
1603
+ rescue SwaggyJenkinsClient::ApiError => e
1604
+ puts "Error when calling BlueOceanApi->get_pipeline_run_nodes: #{e}"
1605
+ end
1606
+ ```
1148
1607
 
1149
- pipeline = "pipeline_example" # String | Name of the pipeline
1608
+ #### Using the get_pipeline_run_nodes_with_http_info variant
1150
1609
 
1151
- run = "run_example" # String | Name of the run
1610
+ This returns an Array which contains the response data, status code and headers.
1152
1611
 
1612
+ > <Array(<Array<PipelineRunNode>>, Integer, Hash)> get_pipeline_run_nodes_with_http_info(organization, pipeline, run)
1153
1613
 
1614
+ ```ruby
1154
1615
  begin
1155
- result = api_instance.get_pipeline_run_nodes(organization, pipeline, run)
1156
- p result
1616
+
1617
+ data, status_code, headers = api_instance.get_pipeline_run_nodes_with_http_info(organization, pipeline, run)
1618
+ p status_code # => 2xx
1619
+ p headers # => { ... }
1620
+ p data # => <Array<PipelineRunNode>>
1157
1621
  rescue SwaggyJenkinsClient::ApiError => e
1158
- puts "Exception when calling BlueOceanApi->get_pipeline_run_nodes: #{e}"
1622
+ puts "Error when calling BlueOceanApi->get_pipeline_run_nodes_with_http_info: #{e}"
1159
1623
  end
1160
1624
  ```
1161
1625
 
1162
1626
  ### Parameters
1163
1627
 
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 |
1628
+ | Name | Type | Description | Notes |
1629
+ | ---- | ---- | ----------- | ----- |
1630
+ | **organization** | **String** | Name of the organization | |
1631
+ | **pipeline** | **String** | Name of the pipeline | |
1632
+ | **run** | **String** | Name of the run | |
1169
1633
 
1170
1634
  ### Return type
1171
1635
 
1172
- [**PipelineRunNodes**](PipelineRunNodes.md)
1636
+ [**Array&lt;PipelineRunNode&gt;**](PipelineRunNode.md)
1173
1637
 
1174
1638
  ### Authorization
1175
1639
 
@@ -1177,21 +1641,22 @@ Name | Type | Description | Notes
1177
1641
 
1178
1642
  ### HTTP request headers
1179
1643
 
1180
- - **Content-Type**: Not defined
1181
- - **Accept**: application/json
1644
+ - **Content-Type**: Not defined
1645
+ - **Accept**: application/json
1182
1646
 
1183
1647
 
1648
+ ## get_pipeline_runs
1184
1649
 
1185
- # **get_pipeline_runs**
1186
- > PipelineRuns get_pipeline_runs(organization, pipeline, )
1650
+ > <Array<PipelineRun>> get_pipeline_runs(organization, pipeline)
1187
1651
 
1188
1652
 
1189
1653
 
1190
1654
  Retrieve all runs details for an organization pipeline
1191
1655
 
1192
- ### Example
1656
+ ### Examples
1657
+
1193
1658
  ```ruby
1194
- # load the gem
1659
+ require 'time'
1195
1660
  require 'swaggy_jenkins'
1196
1661
  # setup authorization
1197
1662
  SwaggyJenkinsClient.configure do |config|
@@ -1201,30 +1666,46 @@ SwaggyJenkinsClient.configure do |config|
1201
1666
  end
1202
1667
 
1203
1668
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1669
+ organization = 'organization_example' # String | Name of the organization
1670
+ pipeline = 'pipeline_example' # String | Name of the pipeline
1671
+
1672
+ begin
1673
+
1674
+ result = api_instance.get_pipeline_runs(organization, pipeline)
1675
+ p result
1676
+ rescue SwaggyJenkinsClient::ApiError => e
1677
+ puts "Error when calling BlueOceanApi->get_pipeline_runs: #{e}"
1678
+ end
1679
+ ```
1204
1680
 
1205
- organization = "organization_example" # String | Name of the organization
1681
+ #### Using the get_pipeline_runs_with_http_info variant
1206
1682
 
1207
- pipeline = "pipeline_example" # String | Name of the pipeline
1683
+ This returns an Array which contains the response data, status code and headers.
1208
1684
 
1685
+ > <Array(<Array<PipelineRun>>, Integer, Hash)> get_pipeline_runs_with_http_info(organization, pipeline)
1209
1686
 
1687
+ ```ruby
1210
1688
  begin
1211
- result = api_instance.get_pipeline_runs(organization, pipeline, )
1212
- p result
1689
+
1690
+ data, status_code, headers = api_instance.get_pipeline_runs_with_http_info(organization, pipeline)
1691
+ p status_code # => 2xx
1692
+ p headers # => { ... }
1693
+ p data # => <Array<PipelineRun>>
1213
1694
  rescue SwaggyJenkinsClient::ApiError => e
1214
- puts "Exception when calling BlueOceanApi->get_pipeline_runs: #{e}"
1695
+ puts "Error when calling BlueOceanApi->get_pipeline_runs_with_http_info: #{e}"
1215
1696
  end
1216
1697
  ```
1217
1698
 
1218
1699
  ### Parameters
1219
1700
 
1220
- Name | Type | Description | Notes
1221
- ------------- | ------------- | ------------- | -------------
1222
- **organization** | **String**| Name of the organization |
1223
- **pipeline** | **String**| Name of the pipeline |
1701
+ | Name | Type | Description | Notes |
1702
+ | ---- | ---- | ----------- | ----- |
1703
+ | **organization** | **String** | Name of the organization | |
1704
+ | **pipeline** | **String** | Name of the pipeline | |
1224
1705
 
1225
1706
  ### Return type
1226
1707
 
1227
- [**PipelineRuns**](PipelineRuns.md)
1708
+ [**Array&lt;PipelineRun&gt;**](PipelineRun.md)
1228
1709
 
1229
1710
  ### Authorization
1230
1711
 
@@ -1232,21 +1713,22 @@ Name | Type | Description | Notes
1232
1713
 
1233
1714
  ### HTTP request headers
1234
1715
 
1235
- - **Content-Type**: Not defined
1236
- - **Accept**: application/json
1716
+ - **Content-Type**: Not defined
1717
+ - **Accept**: application/json
1237
1718
 
1238
1719
 
1720
+ ## get_pipelines
1239
1721
 
1240
- # **get_pipelines**
1241
- > Pipelines get_pipelines(organization, )
1722
+ > <Array<Pipeline>> get_pipelines(organization)
1242
1723
 
1243
1724
 
1244
1725
 
1245
1726
  Retrieve all pipelines details for an organization
1246
1727
 
1247
- ### Example
1728
+ ### Examples
1729
+
1248
1730
  ```ruby
1249
- # load the gem
1731
+ require 'time'
1250
1732
  require 'swaggy_jenkins'
1251
1733
  # setup authorization
1252
1734
  SwaggyJenkinsClient.configure do |config|
@@ -1256,27 +1738,44 @@ SwaggyJenkinsClient.configure do |config|
1256
1738
  end
1257
1739
 
1258
1740
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1741
+ organization = 'organization_example' # String | Name of the organization
1742
+
1743
+ begin
1744
+
1745
+ result = api_instance.get_pipelines(organization)
1746
+ p result
1747
+ rescue SwaggyJenkinsClient::ApiError => e
1748
+ puts "Error when calling BlueOceanApi->get_pipelines: #{e}"
1749
+ end
1750
+ ```
1259
1751
 
1260
- organization = "organization_example" # String | Name of the organization
1752
+ #### Using the get_pipelines_with_http_info variant
1261
1753
 
1754
+ This returns an Array which contains the response data, status code and headers.
1262
1755
 
1756
+ > <Array(<Array<Pipeline>>, Integer, Hash)> get_pipelines_with_http_info(organization)
1757
+
1758
+ ```ruby
1263
1759
  begin
1264
- result = api_instance.get_pipelines(organization, )
1265
- p result
1760
+
1761
+ data, status_code, headers = api_instance.get_pipelines_with_http_info(organization)
1762
+ p status_code # => 2xx
1763
+ p headers # => { ... }
1764
+ p data # => <Array<Pipeline>>
1266
1765
  rescue SwaggyJenkinsClient::ApiError => e
1267
- puts "Exception when calling BlueOceanApi->get_pipelines: #{e}"
1766
+ puts "Error when calling BlueOceanApi->get_pipelines_with_http_info: #{e}"
1268
1767
  end
1269
1768
  ```
1270
1769
 
1271
1770
  ### Parameters
1272
1771
 
1273
- Name | Type | Description | Notes
1274
- ------------- | ------------- | ------------- | -------------
1275
- **organization** | **String**| Name of the organization |
1772
+ | Name | Type | Description | Notes |
1773
+ | ---- | ---- | ----------- | ----- |
1774
+ | **organization** | **String** | Name of the organization | |
1276
1775
 
1277
1776
  ### Return type
1278
1777
 
1279
- [**Pipelines**](Pipelines.md)
1778
+ [**Array&lt;Pipeline&gt;**](Pipeline.md)
1280
1779
 
1281
1780
  ### Authorization
1282
1781
 
@@ -1284,21 +1783,22 @@ Name | Type | Description | Notes
1284
1783
 
1285
1784
  ### HTTP request headers
1286
1785
 
1287
- - **Content-Type**: Not defined
1288
- - **Accept**: application/json
1786
+ - **Content-Type**: Not defined
1787
+ - **Accept**: application/json
1289
1788
 
1290
1789
 
1790
+ ## get_scm
1291
1791
 
1292
- # **get_scm**
1293
- > GithubScm get_scm(organization, scm, )
1792
+ > <GithubScm> get_scm(organization, scm)
1294
1793
 
1295
1794
 
1296
1795
 
1297
1796
  Retrieve SCM details for an organization
1298
1797
 
1299
- ### Example
1798
+ ### Examples
1799
+
1300
1800
  ```ruby
1301
- # load the gem
1801
+ require 'time'
1302
1802
  require 'swaggy_jenkins'
1303
1803
  # setup authorization
1304
1804
  SwaggyJenkinsClient.configure do |config|
@@ -1308,26 +1808,42 @@ SwaggyJenkinsClient.configure do |config|
1308
1808
  end
1309
1809
 
1310
1810
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1811
+ organization = 'organization_example' # String | Name of the organization
1812
+ scm = 'scm_example' # String | Name of SCM
1813
+
1814
+ begin
1815
+
1816
+ result = api_instance.get_scm(organization, scm)
1817
+ p result
1818
+ rescue SwaggyJenkinsClient::ApiError => e
1819
+ puts "Error when calling BlueOceanApi->get_scm: #{e}"
1820
+ end
1821
+ ```
1311
1822
 
1312
- organization = "organization_example" # String | Name of the organization
1823
+ #### Using the get_scm_with_http_info variant
1313
1824
 
1314
- scm = "scm_example" # String | Name of SCM
1825
+ This returns an Array which contains the response data, status code and headers.
1315
1826
 
1827
+ > <Array(<GithubScm>, Integer, Hash)> get_scm_with_http_info(organization, scm)
1316
1828
 
1829
+ ```ruby
1317
1830
  begin
1318
- result = api_instance.get_scm(organization, scm, )
1319
- p result
1831
+
1832
+ data, status_code, headers = api_instance.get_scm_with_http_info(organization, scm)
1833
+ p status_code # => 2xx
1834
+ p headers # => { ... }
1835
+ p data # => <GithubScm>
1320
1836
  rescue SwaggyJenkinsClient::ApiError => e
1321
- puts "Exception when calling BlueOceanApi->get_scm: #{e}"
1837
+ puts "Error when calling BlueOceanApi->get_scm_with_http_info: #{e}"
1322
1838
  end
1323
1839
  ```
1324
1840
 
1325
1841
  ### Parameters
1326
1842
 
1327
- Name | Type | Description | Notes
1328
- ------------- | ------------- | ------------- | -------------
1329
- **organization** | **String**| Name of the organization |
1330
- **scm** | **String**| Name of SCM |
1843
+ | Name | Type | Description | Notes |
1844
+ | ---- | ---- | ----------- | ----- |
1845
+ | **organization** | **String** | Name of the organization | |
1846
+ | **scm** | **String** | Name of SCM | |
1331
1847
 
1332
1848
  ### Return type
1333
1849
 
@@ -1339,21 +1855,22 @@ Name | Type | Description | Notes
1339
1855
 
1340
1856
  ### HTTP request headers
1341
1857
 
1342
- - **Content-Type**: Not defined
1343
- - **Accept**: application/json
1858
+ - **Content-Type**: Not defined
1859
+ - **Accept**: application/json
1344
1860
 
1345
1861
 
1862
+ ## get_scm_organisation_repositories
1346
1863
 
1347
- # **get_scm_organisation_repositories**
1348
- > ScmOrganisations get_scm_organisation_repositories(organization, scm, scm_organisation, , opts)
1864
+ > <Array<GithubOrganization>> get_scm_organisation_repositories(organization, scm, scm_organisation, opts)
1349
1865
 
1350
1866
 
1351
1867
 
1352
1868
  Retrieve SCM organization repositories details for an organization
1353
1869
 
1354
- ### Example
1870
+ ### Examples
1871
+
1355
1872
  ```ruby
1356
- # load the gem
1873
+ require 'time'
1357
1874
  require 'swaggy_jenkins'
1358
1875
  # setup authorization
1359
1876
  SwaggyJenkinsClient.configure do |config|
@@ -1363,41 +1880,56 @@ SwaggyJenkinsClient.configure do |config|
1363
1880
  end
1364
1881
 
1365
1882
  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
1883
+ organization = 'organization_example' # String | Name of the organization
1884
+ scm = 'scm_example' # String | Name of SCM
1885
+ scm_organisation = 'scm_organisation_example' # String | Name of the SCM organization
1886
+ opts = {
1887
+ credential_id: 'credential_id_example', # String | Credential ID
1375
1888
  page_size: 56, # Integer | Number of items in a page
1376
1889
  page_number: 56 # Integer | Page number
1377
1890
  }
1378
1891
 
1379
1892
  begin
1380
- result = api_instance.get_scm_organisation_repositories(organization, scm, scm_organisation, , opts)
1893
+
1894
+ result = api_instance.get_scm_organisation_repositories(organization, scm, scm_organisation, opts)
1381
1895
  p result
1382
1896
  rescue SwaggyJenkinsClient::ApiError => e
1383
- puts "Exception when calling BlueOceanApi->get_scm_organisation_repositories: #{e}"
1897
+ puts "Error when calling BlueOceanApi->get_scm_organisation_repositories: #{e}"
1898
+ end
1899
+ ```
1900
+
1901
+ #### Using the get_scm_organisation_repositories_with_http_info variant
1902
+
1903
+ This returns an Array which contains the response data, status code and headers.
1904
+
1905
+ > <Array(<Array<GithubOrganization>>, Integer, Hash)> get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts)
1906
+
1907
+ ```ruby
1908
+ begin
1909
+
1910
+ data, status_code, headers = api_instance.get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts)
1911
+ p status_code # => 2xx
1912
+ p headers # => { ... }
1913
+ p data # => <Array<GithubOrganization>>
1914
+ rescue SwaggyJenkinsClient::ApiError => e
1915
+ puts "Error when calling BlueOceanApi->get_scm_organisation_repositories_with_http_info: #{e}"
1384
1916
  end
1385
1917
  ```
1386
1918
 
1387
1919
  ### Parameters
1388
1920
 
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]
1921
+ | Name | Type | Description | Notes |
1922
+ | ---- | ---- | ----------- | ----- |
1923
+ | **organization** | **String** | Name of the organization | |
1924
+ | **scm** | **String** | Name of SCM | |
1925
+ | **scm_organisation** | **String** | Name of the SCM organization | |
1926
+ | **credential_id** | **String** | Credential ID | [optional] |
1927
+ | **page_size** | **Integer** | Number of items in a page | [optional] |
1928
+ | **page_number** | **Integer** | Page number | [optional] |
1397
1929
 
1398
1930
  ### Return type
1399
1931
 
1400
- [**ScmOrganisations**](ScmOrganisations.md)
1932
+ [**Array&lt;GithubOrganization&gt;**](GithubOrganization.md)
1401
1933
 
1402
1934
  ### Authorization
1403
1935
 
@@ -1405,21 +1937,22 @@ Name | Type | Description | Notes
1405
1937
 
1406
1938
  ### HTTP request headers
1407
1939
 
1408
- - **Content-Type**: Not defined
1409
- - **Accept**: application/json
1940
+ - **Content-Type**: Not defined
1941
+ - **Accept**: application/json
1410
1942
 
1411
1943
 
1944
+ ## get_scm_organisation_repository
1412
1945
 
1413
- # **get_scm_organisation_repository**
1414
- > ScmOrganisations get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
1946
+ > <Array<GithubOrganization>> get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
1415
1947
 
1416
1948
 
1417
1949
 
1418
1950
  Retrieve SCM organization repository details for an organization
1419
1951
 
1420
- ### Example
1952
+ ### Examples
1953
+
1421
1954
  ```ruby
1422
- # load the gem
1955
+ require 'time'
1423
1956
  require 'swaggy_jenkins'
1424
1957
  # setup authorization
1425
1958
  SwaggyJenkinsClient.configure do |config|
@@ -1429,40 +1962,54 @@ SwaggyJenkinsClient.configure do |config|
1429
1962
  end
1430
1963
 
1431
1964
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1965
+ organization = 'organization_example' # String | Name of the organization
1966
+ scm = 'scm_example' # String | Name of SCM
1967
+ scm_organisation = 'scm_organisation_example' # String | Name of the SCM organization
1968
+ repository = 'repository_example' # String | Name of the SCM repository
1969
+ opts = {
1970
+ credential_id: 'credential_id_example' # String | Credential ID
1971
+ }
1432
1972
 
1433
- organization = "organization_example" # String | Name of the organization
1434
-
1435
- scm = "scm_example" # String | Name of SCM
1973
+ begin
1974
+
1975
+ result = api_instance.get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
1976
+ p result
1977
+ rescue SwaggyJenkinsClient::ApiError => e
1978
+ puts "Error when calling BlueOceanApi->get_scm_organisation_repository: #{e}"
1979
+ end
1980
+ ```
1436
1981
 
1437
- scm_organisation = "scm_organisation_example" # String | Name of the SCM organization
1982
+ #### Using the get_scm_organisation_repository_with_http_info variant
1438
1983
 
1439
- repository = "repository_example" # String | Name of the SCM repository
1984
+ This returns an Array which contains the response data, status code and headers.
1440
1985
 
1441
- opts = {
1442
- credential_id: "credential_id_example" # String | Credential ID
1443
- }
1986
+ > <Array(<Array<GithubOrganization>>, Integer, Hash)> get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts)
1444
1987
 
1988
+ ```ruby
1445
1989
  begin
1446
- result = api_instance.get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts)
1447
- p result
1990
+
1991
+ data, status_code, headers = api_instance.get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts)
1992
+ p status_code # => 2xx
1993
+ p headers # => { ... }
1994
+ p data # => <Array<GithubOrganization>>
1448
1995
  rescue SwaggyJenkinsClient::ApiError => e
1449
- puts "Exception when calling BlueOceanApi->get_scm_organisation_repository: #{e}"
1996
+ puts "Error when calling BlueOceanApi->get_scm_organisation_repository_with_http_info: #{e}"
1450
1997
  end
1451
1998
  ```
1452
1999
 
1453
2000
  ### Parameters
1454
2001
 
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]
2002
+ | Name | Type | Description | Notes |
2003
+ | ---- | ---- | ----------- | ----- |
2004
+ | **organization** | **String** | Name of the organization | |
2005
+ | **scm** | **String** | Name of SCM | |
2006
+ | **scm_organisation** | **String** | Name of the SCM organization | |
2007
+ | **repository** | **String** | Name of the SCM repository | |
2008
+ | **credential_id** | **String** | Credential ID | [optional] |
1462
2009
 
1463
2010
  ### Return type
1464
2011
 
1465
- [**ScmOrganisations**](ScmOrganisations.md)
2012
+ [**Array&lt;GithubOrganization&gt;**](GithubOrganization.md)
1466
2013
 
1467
2014
  ### Authorization
1468
2015
 
@@ -1470,21 +2017,22 @@ Name | Type | Description | Notes
1470
2017
 
1471
2018
  ### HTTP request headers
1472
2019
 
1473
- - **Content-Type**: Not defined
1474
- - **Accept**: application/json
2020
+ - **Content-Type**: Not defined
2021
+ - **Accept**: application/json
1475
2022
 
1476
2023
 
2024
+ ## get_scm_organisations
1477
2025
 
1478
- # **get_scm_organisations**
1479
- > ScmOrganisations get_scm_organisations(organization, scm, , opts)
2026
+ > <Array<GithubOrganization>> get_scm_organisations(organization, scm, opts)
1480
2027
 
1481
2028
 
1482
2029
 
1483
2030
  Retrieve SCM organizations details for an organization
1484
2031
 
1485
- ### Example
2032
+ ### Examples
2033
+
1486
2034
  ```ruby
1487
- # load the gem
2035
+ require 'time'
1488
2036
  require 'swaggy_jenkins'
1489
2037
  # setup authorization
1490
2038
  SwaggyJenkinsClient.configure do |config|
@@ -1494,34 +2042,50 @@ SwaggyJenkinsClient.configure do |config|
1494
2042
  end
1495
2043
 
1496
2044
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2045
+ organization = 'organization_example' # String | Name of the organization
2046
+ scm = 'scm_example' # String | Name of SCM
2047
+ opts = {
2048
+ credential_id: 'credential_id_example' # String | Credential ID
2049
+ }
1497
2050
 
1498
- organization = "organization_example" # String | Name of the organization
2051
+ begin
2052
+
2053
+ result = api_instance.get_scm_organisations(organization, scm, opts)
2054
+ p result
2055
+ rescue SwaggyJenkinsClient::ApiError => e
2056
+ puts "Error when calling BlueOceanApi->get_scm_organisations: #{e}"
2057
+ end
2058
+ ```
1499
2059
 
1500
- scm = "scm_example" # String | Name of SCM
2060
+ #### Using the get_scm_organisations_with_http_info variant
1501
2061
 
1502
- opts = {
1503
- credential_id: "credential_id_example" # String | Credential ID
1504
- }
2062
+ This returns an Array which contains the response data, status code and headers.
1505
2063
 
2064
+ > <Array(<Array<GithubOrganization>>, Integer, Hash)> get_scm_organisations_with_http_info(organization, scm, opts)
2065
+
2066
+ ```ruby
1506
2067
  begin
1507
- result = api_instance.get_scm_organisations(organization, scm, , opts)
1508
- p result
2068
+
2069
+ data, status_code, headers = api_instance.get_scm_organisations_with_http_info(organization, scm, opts)
2070
+ p status_code # => 2xx
2071
+ p headers # => { ... }
2072
+ p data # => <Array<GithubOrganization>>
1509
2073
  rescue SwaggyJenkinsClient::ApiError => e
1510
- puts "Exception when calling BlueOceanApi->get_scm_organisations: #{e}"
2074
+ puts "Error when calling BlueOceanApi->get_scm_organisations_with_http_info: #{e}"
1511
2075
  end
1512
2076
  ```
1513
2077
 
1514
2078
  ### Parameters
1515
2079
 
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]
2080
+ | Name | Type | Description | Notes |
2081
+ | ---- | ---- | ----------- | ----- |
2082
+ | **organization** | **String** | Name of the organization | |
2083
+ | **scm** | **String** | Name of SCM | |
2084
+ | **credential_id** | **String** | Credential ID | [optional] |
1521
2085
 
1522
2086
  ### Return type
1523
2087
 
1524
- [**ScmOrganisations**](ScmOrganisations.md)
2088
+ [**Array&lt;GithubOrganization&gt;**](GithubOrganization.md)
1525
2089
 
1526
2090
  ### Authorization
1527
2091
 
@@ -1529,21 +2093,22 @@ Name | Type | Description | Notes
1529
2093
 
1530
2094
  ### HTTP request headers
1531
2095
 
1532
- - **Content-Type**: Not defined
1533
- - **Accept**: application/json
2096
+ - **Content-Type**: Not defined
2097
+ - **Accept**: application/json
1534
2098
 
1535
2099
 
2100
+ ## get_user
1536
2101
 
1537
- # **get_user**
1538
- > User get_user(organization, user)
2102
+ > <User> get_user(organization, user)
1539
2103
 
1540
2104
 
1541
2105
 
1542
2106
  Retrieve user details for an organization
1543
2107
 
1544
- ### Example
2108
+ ### Examples
2109
+
1545
2110
  ```ruby
1546
- # load the gem
2111
+ require 'time'
1547
2112
  require 'swaggy_jenkins'
1548
2113
  # setup authorization
1549
2114
  SwaggyJenkinsClient.configure do |config|
@@ -1553,26 +2118,42 @@ SwaggyJenkinsClient.configure do |config|
1553
2118
  end
1554
2119
 
1555
2120
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2121
+ organization = 'organization_example' # String | Name of the organization
2122
+ user = 'user_example' # String | Name of the user
2123
+
2124
+ begin
2125
+
2126
+ result = api_instance.get_user(organization, user)
2127
+ p result
2128
+ rescue SwaggyJenkinsClient::ApiError => e
2129
+ puts "Error when calling BlueOceanApi->get_user: #{e}"
2130
+ end
2131
+ ```
1556
2132
 
1557
- organization = "organization_example" # String | Name of the organization
2133
+ #### Using the get_user_with_http_info variant
1558
2134
 
1559
- user = "user_example" # String | Name of the user
2135
+ This returns an Array which contains the response data, status code and headers.
1560
2136
 
2137
+ > <Array(<User>, Integer, Hash)> get_user_with_http_info(organization, user)
1561
2138
 
2139
+ ```ruby
1562
2140
  begin
1563
- result = api_instance.get_user(organization, user)
1564
- p result
2141
+
2142
+ data, status_code, headers = api_instance.get_user_with_http_info(organization, user)
2143
+ p status_code # => 2xx
2144
+ p headers # => { ... }
2145
+ p data # => <User>
1565
2146
  rescue SwaggyJenkinsClient::ApiError => e
1566
- puts "Exception when calling BlueOceanApi->get_user: #{e}"
2147
+ puts "Error when calling BlueOceanApi->get_user_with_http_info: #{e}"
1567
2148
  end
1568
2149
  ```
1569
2150
 
1570
2151
  ### Parameters
1571
2152
 
1572
- Name | Type | Description | Notes
1573
- ------------- | ------------- | ------------- | -------------
1574
- **organization** | **String**| Name of the organization |
1575
- **user** | **String**| Name of the user |
2153
+ | Name | Type | Description | Notes |
2154
+ | ---- | ---- | ----------- | ----- |
2155
+ | **organization** | **String** | Name of the organization | |
2156
+ | **user** | **String** | Name of the user | |
1576
2157
 
1577
2158
  ### Return type
1578
2159
 
@@ -1584,21 +2165,22 @@ Name | Type | Description | Notes
1584
2165
 
1585
2166
  ### HTTP request headers
1586
2167
 
1587
- - **Content-Type**: Not defined
1588
- - **Accept**: application/json
2168
+ - **Content-Type**: Not defined
2169
+ - **Accept**: application/json
1589
2170
 
1590
2171
 
2172
+ ## get_user_favorites
1591
2173
 
1592
- # **get_user_favorites**
1593
- > UserFavorites get_user_favorites(user)
2174
+ > <Array<FavoriteImpl>> get_user_favorites(user)
1594
2175
 
1595
2176
 
1596
2177
 
1597
2178
  Retrieve user favorites details for an organization
1598
2179
 
1599
- ### Example
2180
+ ### Examples
2181
+
1600
2182
  ```ruby
1601
- # load the gem
2183
+ require 'time'
1602
2184
  require 'swaggy_jenkins'
1603
2185
  # setup authorization
1604
2186
  SwaggyJenkinsClient.configure do |config|
@@ -1608,27 +2190,44 @@ SwaggyJenkinsClient.configure do |config|
1608
2190
  end
1609
2191
 
1610
2192
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1611
-
1612
- user = "user_example" # String | Name of the user
1613
-
2193
+ user = 'user_example' # String | Name of the user
1614
2194
 
1615
2195
  begin
2196
+
1616
2197
  result = api_instance.get_user_favorites(user)
1617
2198
  p result
1618
2199
  rescue SwaggyJenkinsClient::ApiError => e
1619
- puts "Exception when calling BlueOceanApi->get_user_favorites: #{e}"
2200
+ puts "Error when calling BlueOceanApi->get_user_favorites: #{e}"
2201
+ end
2202
+ ```
2203
+
2204
+ #### Using the get_user_favorites_with_http_info variant
2205
+
2206
+ This returns an Array which contains the response data, status code and headers.
2207
+
2208
+ > <Array(<Array<FavoriteImpl>>, Integer, Hash)> get_user_favorites_with_http_info(user)
2209
+
2210
+ ```ruby
2211
+ begin
2212
+
2213
+ data, status_code, headers = api_instance.get_user_favorites_with_http_info(user)
2214
+ p status_code # => 2xx
2215
+ p headers # => { ... }
2216
+ p data # => <Array<FavoriteImpl>>
2217
+ rescue SwaggyJenkinsClient::ApiError => e
2218
+ puts "Error when calling BlueOceanApi->get_user_favorites_with_http_info: #{e}"
1620
2219
  end
1621
2220
  ```
1622
2221
 
1623
2222
  ### Parameters
1624
2223
 
1625
- Name | Type | Description | Notes
1626
- ------------- | ------------- | ------------- | -------------
1627
- **user** | **String**| Name of the user |
2224
+ | Name | Type | Description | Notes |
2225
+ | ---- | ---- | ----------- | ----- |
2226
+ | **user** | **String** | Name of the user | |
1628
2227
 
1629
2228
  ### Return type
1630
2229
 
1631
- [**UserFavorites**](UserFavorites.md)
2230
+ [**Array&lt;FavoriteImpl&gt;**](FavoriteImpl.md)
1632
2231
 
1633
2232
  ### Authorization
1634
2233
 
@@ -1636,21 +2235,22 @@ Name | Type | Description | Notes
1636
2235
 
1637
2236
  ### HTTP request headers
1638
2237
 
1639
- - **Content-Type**: Not defined
1640
- - **Accept**: application/json
2238
+ - **Content-Type**: Not defined
2239
+ - **Accept**: application/json
1641
2240
 
1642
2241
 
2242
+ ## get_users
1643
2243
 
1644
- # **get_users**
1645
- > User get_users(organization, )
2244
+ > <User> get_users(organization)
1646
2245
 
1647
2246
 
1648
2247
 
1649
2248
  Retrieve users details for an organization
1650
2249
 
1651
- ### Example
2250
+ ### Examples
2251
+
1652
2252
  ```ruby
1653
- # load the gem
2253
+ require 'time'
1654
2254
  require 'swaggy_jenkins'
1655
2255
  # setup authorization
1656
2256
  SwaggyJenkinsClient.configure do |config|
@@ -1660,23 +2260,40 @@ SwaggyJenkinsClient.configure do |config|
1660
2260
  end
1661
2261
 
1662
2262
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2263
+ organization = 'organization_example' # String | Name of the organization
2264
+
2265
+ begin
2266
+
2267
+ result = api_instance.get_users(organization)
2268
+ p result
2269
+ rescue SwaggyJenkinsClient::ApiError => e
2270
+ puts "Error when calling BlueOceanApi->get_users: #{e}"
2271
+ end
2272
+ ```
2273
+
2274
+ #### Using the get_users_with_http_info variant
1663
2275
 
1664
- organization = "organization_example" # String | Name of the organization
2276
+ This returns an Array which contains the response data, status code and headers.
1665
2277
 
2278
+ > <Array(<User>, Integer, Hash)> get_users_with_http_info(organization)
1666
2279
 
2280
+ ```ruby
1667
2281
  begin
1668
- result = api_instance.get_users(organization, )
1669
- p result
2282
+
2283
+ data, status_code, headers = api_instance.get_users_with_http_info(organization)
2284
+ p status_code # => 2xx
2285
+ p headers # => { ... }
2286
+ p data # => <User>
1670
2287
  rescue SwaggyJenkinsClient::ApiError => e
1671
- puts "Exception when calling BlueOceanApi->get_users: #{e}"
2288
+ puts "Error when calling BlueOceanApi->get_users_with_http_info: #{e}"
1672
2289
  end
1673
2290
  ```
1674
2291
 
1675
2292
  ### Parameters
1676
2293
 
1677
- Name | Type | Description | Notes
1678
- ------------- | ------------- | ------------- | -------------
1679
- **organization** | **String**| Name of the organization |
2294
+ | Name | Type | Description | Notes |
2295
+ | ---- | ---- | ----------- | ----- |
2296
+ | **organization** | **String** | Name of the organization | |
1680
2297
 
1681
2298
  ### Return type
1682
2299
 
@@ -1688,21 +2305,22 @@ Name | Type | Description | Notes
1688
2305
 
1689
2306
  ### HTTP request headers
1690
2307
 
1691
- - **Content-Type**: Not defined
1692
- - **Accept**: application/json
2308
+ - **Content-Type**: Not defined
2309
+ - **Accept**: application/json
1693
2310
 
1694
2311
 
2312
+ ## post_pipeline_run
1695
2313
 
1696
- # **post_pipeline_run**
1697
- > QueueItemImpl post_pipeline_run(organization, pipeline, run)
2314
+ > <QueueItemImpl> post_pipeline_run(organization, pipeline, run)
1698
2315
 
1699
2316
 
1700
2317
 
1701
2318
  Replay an organization pipeline run
1702
2319
 
1703
- ### Example
2320
+ ### Examples
2321
+
1704
2322
  ```ruby
1705
- # load the gem
2323
+ require 'time'
1706
2324
  require 'swaggy_jenkins'
1707
2325
  # setup authorization
1708
2326
  SwaggyJenkinsClient.configure do |config|
@@ -1712,29 +2330,44 @@ SwaggyJenkinsClient.configure do |config|
1712
2330
  end
1713
2331
 
1714
2332
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2333
+ organization = 'organization_example' # String | Name of the organization
2334
+ pipeline = 'pipeline_example' # String | Name of the pipeline
2335
+ run = 'run_example' # String | Name of the run
1715
2336
 
1716
- organization = "organization_example" # String | Name of the organization
2337
+ begin
2338
+
2339
+ result = api_instance.post_pipeline_run(organization, pipeline, run)
2340
+ p result
2341
+ rescue SwaggyJenkinsClient::ApiError => e
2342
+ puts "Error when calling BlueOceanApi->post_pipeline_run: #{e}"
2343
+ end
2344
+ ```
1717
2345
 
1718
- pipeline = "pipeline_example" # String | Name of the pipeline
2346
+ #### Using the post_pipeline_run_with_http_info variant
1719
2347
 
1720
- run = "run_example" # String | Name of the run
2348
+ This returns an Array which contains the response data, status code and headers.
1721
2349
 
2350
+ > <Array(<QueueItemImpl>, Integer, Hash)> post_pipeline_run_with_http_info(organization, pipeline, run)
1722
2351
 
2352
+ ```ruby
1723
2353
  begin
1724
- result = api_instance.post_pipeline_run(organization, pipeline, run)
1725
- p result
2354
+
2355
+ data, status_code, headers = api_instance.post_pipeline_run_with_http_info(organization, pipeline, run)
2356
+ p status_code # => 2xx
2357
+ p headers # => { ... }
2358
+ p data # => <QueueItemImpl>
1726
2359
  rescue SwaggyJenkinsClient::ApiError => e
1727
- puts "Exception when calling BlueOceanApi->post_pipeline_run: #{e}"
2360
+ puts "Error when calling BlueOceanApi->post_pipeline_run_with_http_info: #{e}"
1728
2361
  end
1729
2362
  ```
1730
2363
 
1731
2364
  ### Parameters
1732
2365
 
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 |
2366
+ | Name | Type | Description | Notes |
2367
+ | ---- | ---- | ----------- | ----- |
2368
+ | **organization** | **String** | Name of the organization | |
2369
+ | **pipeline** | **String** | Name of the pipeline | |
2370
+ | **run** | **String** | Name of the run | |
1738
2371
 
1739
2372
  ### Return type
1740
2373
 
@@ -1746,21 +2379,22 @@ Name | Type | Description | Notes
1746
2379
 
1747
2380
  ### HTTP request headers
1748
2381
 
1749
- - **Content-Type**: Not defined
1750
- - **Accept**: application/json
2382
+ - **Content-Type**: Not defined
2383
+ - **Accept**: application/json
1751
2384
 
1752
2385
 
2386
+ ## post_pipeline_runs
1753
2387
 
1754
- # **post_pipeline_runs**
1755
- > QueueItemImpl post_pipeline_runs(organization, pipeline, )
2388
+ > <QueueItemImpl> post_pipeline_runs(organization, pipeline)
1756
2389
 
1757
2390
 
1758
2391
 
1759
2392
  Start a build for an organization pipeline
1760
2393
 
1761
- ### Example
2394
+ ### Examples
2395
+
1762
2396
  ```ruby
1763
- # load the gem
2397
+ require 'time'
1764
2398
  require 'swaggy_jenkins'
1765
2399
  # setup authorization
1766
2400
  SwaggyJenkinsClient.configure do |config|
@@ -1770,26 +2404,42 @@ SwaggyJenkinsClient.configure do |config|
1770
2404
  end
1771
2405
 
1772
2406
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2407
+ organization = 'organization_example' # String | Name of the organization
2408
+ pipeline = 'pipeline_example' # String | Name of the pipeline
2409
+
2410
+ begin
2411
+
2412
+ result = api_instance.post_pipeline_runs(organization, pipeline)
2413
+ p result
2414
+ rescue SwaggyJenkinsClient::ApiError => e
2415
+ puts "Error when calling BlueOceanApi->post_pipeline_runs: #{e}"
2416
+ end
2417
+ ```
1773
2418
 
1774
- organization = "organization_example" # String | Name of the organization
2419
+ #### Using the post_pipeline_runs_with_http_info variant
1775
2420
 
1776
- pipeline = "pipeline_example" # String | Name of the pipeline
2421
+ This returns an Array which contains the response data, status code and headers.
1777
2422
 
2423
+ > <Array(<QueueItemImpl>, Integer, Hash)> post_pipeline_runs_with_http_info(organization, pipeline)
1778
2424
 
2425
+ ```ruby
1779
2426
  begin
1780
- result = api_instance.post_pipeline_runs(organization, pipeline, )
1781
- p result
2427
+
2428
+ data, status_code, headers = api_instance.post_pipeline_runs_with_http_info(organization, pipeline)
2429
+ p status_code # => 2xx
2430
+ p headers # => { ... }
2431
+ p data # => <QueueItemImpl>
1782
2432
  rescue SwaggyJenkinsClient::ApiError => e
1783
- puts "Exception when calling BlueOceanApi->post_pipeline_runs: #{e}"
2433
+ puts "Error when calling BlueOceanApi->post_pipeline_runs_with_http_info: #{e}"
1784
2434
  end
1785
2435
  ```
1786
2436
 
1787
2437
  ### Parameters
1788
2438
 
1789
- Name | Type | Description | Notes
1790
- ------------- | ------------- | ------------- | -------------
1791
- **organization** | **String**| Name of the organization |
1792
- **pipeline** | **String**| Name of the pipeline |
2439
+ | Name | Type | Description | Notes |
2440
+ | ---- | ---- | ----------- | ----- |
2441
+ | **organization** | **String** | Name of the organization | |
2442
+ | **pipeline** | **String** | Name of the pipeline | |
1793
2443
 
1794
2444
  ### Return type
1795
2445
 
@@ -1801,21 +2451,22 @@ Name | Type | Description | Notes
1801
2451
 
1802
2452
  ### HTTP request headers
1803
2453
 
1804
- - **Content-Type**: Not defined
1805
- - **Accept**: application/json
2454
+ - **Content-Type**: Not defined
2455
+ - **Accept**: application/json
1806
2456
 
1807
2457
 
2458
+ ## put_pipeline_favorite
1808
2459
 
1809
- # **put_pipeline_favorite**
1810
- > FavoriteImpl put_pipeline_favorite(organization, pipeline, body)
2460
+ > <FavoriteImpl> put_pipeline_favorite(organization, pipeline, body)
1811
2461
 
1812
2462
 
1813
2463
 
1814
2464
  Favorite/unfavorite a pipeline
1815
2465
 
1816
- ### Example
2466
+ ### Examples
2467
+
1817
2468
  ```ruby
1818
- # load the gem
2469
+ require 'time'
1819
2470
  require 'swaggy_jenkins'
1820
2471
  # setup authorization
1821
2472
  SwaggyJenkinsClient.configure do |config|
@@ -1825,29 +2476,44 @@ SwaggyJenkinsClient.configure do |config|
1825
2476
  end
1826
2477
 
1827
2478
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2479
+ organization = 'organization_example' # String | Name of the organization
2480
+ pipeline = 'pipeline_example' # String | Name of the pipeline
2481
+ body = true # Boolean | Set JSON string body to {\"favorite\": true} to favorite, set value to false to unfavorite
1828
2482
 
1829
- organization = "organization_example" # String | Name of the organization
2483
+ begin
2484
+
2485
+ result = api_instance.put_pipeline_favorite(organization, pipeline, body)
2486
+ p result
2487
+ rescue SwaggyJenkinsClient::ApiError => e
2488
+ puts "Error when calling BlueOceanApi->put_pipeline_favorite: #{e}"
2489
+ end
2490
+ ```
1830
2491
 
1831
- pipeline = "pipeline_example" # String | Name of the pipeline
2492
+ #### Using the put_pipeline_favorite_with_http_info variant
1832
2493
 
1833
- body = SwaggyJenkinsClient::Body.new # Body | Set JSON string body to {\"favorite\": true} to favorite, set value to false to unfavorite
2494
+ This returns an Array which contains the response data, status code and headers.
1834
2495
 
2496
+ > <Array(<FavoriteImpl>, Integer, Hash)> put_pipeline_favorite_with_http_info(organization, pipeline, body)
1835
2497
 
2498
+ ```ruby
1836
2499
  begin
1837
- result = api_instance.put_pipeline_favorite(organization, pipeline, body)
1838
- p result
2500
+
2501
+ data, status_code, headers = api_instance.put_pipeline_favorite_with_http_info(organization, pipeline, body)
2502
+ p status_code # => 2xx
2503
+ p headers # => { ... }
2504
+ p data # => <FavoriteImpl>
1839
2505
  rescue SwaggyJenkinsClient::ApiError => e
1840
- puts "Exception when calling BlueOceanApi->put_pipeline_favorite: #{e}"
2506
+ puts "Error when calling BlueOceanApi->put_pipeline_favorite_with_http_info: #{e}"
1841
2507
  end
1842
2508
  ```
1843
2509
 
1844
2510
  ### Parameters
1845
2511
 
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 {\&quot;favorite\&quot;: true} to favorite, set value to false to unfavorite |
2512
+ | Name | Type | Description | Notes |
2513
+ | ---- | ---- | ----------- | ----- |
2514
+ | **organization** | **String** | Name of the organization | |
2515
+ | **pipeline** | **String** | Name of the pipeline | |
2516
+ | **body** | **Boolean** | Set JSON string body to {\&quot;favorite\&quot;: true} to favorite, set value to false to unfavorite | |
1851
2517
 
1852
2518
  ### Return type
1853
2519
 
@@ -1859,21 +2525,22 @@ Name | Type | Description | Notes
1859
2525
 
1860
2526
  ### HTTP request headers
1861
2527
 
1862
- - **Content-Type**: Not defined
1863
- - **Accept**: application/json
2528
+ - **Content-Type**: application/json
2529
+ - **Accept**: application/json
1864
2530
 
1865
2531
 
2532
+ ## put_pipeline_run
1866
2533
 
1867
- # **put_pipeline_run**
1868
- > PipelineRun put_pipeline_run(organization, pipeline, run, opts)
2534
+ > <PipelineRun> put_pipeline_run(organization, pipeline, run, opts)
1869
2535
 
1870
2536
 
1871
2537
 
1872
2538
  Stop a build of an organization pipeline
1873
2539
 
1874
- ### Example
2540
+ ### Examples
2541
+
1875
2542
  ```ruby
1876
- # load the gem
2543
+ require 'time'
1877
2544
  require 'swaggy_jenkins'
1878
2545
  # setup authorization
1879
2546
  SwaggyJenkinsClient.configure do |config|
@@ -1883,35 +2550,50 @@ SwaggyJenkinsClient.configure do |config|
1883
2550
  end
1884
2551
 
1885
2552
  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
2553
+ organization = 'organization_example' # String | Name of the organization
2554
+ pipeline = 'pipeline_example' # String | Name of the pipeline
2555
+ run = 'run_example' # String | Name of the run
2556
+ opts = {
2557
+ blocking: 'blocking_example', # String | Set to true to make blocking stop, default: false
1895
2558
  time_out_in_secs: 56 # Integer | Timeout in seconds, default: 10 seconds
1896
2559
  }
1897
2560
 
1898
2561
  begin
2562
+
1899
2563
  result = api_instance.put_pipeline_run(organization, pipeline, run, opts)
1900
2564
  p result
1901
2565
  rescue SwaggyJenkinsClient::ApiError => e
1902
- puts "Exception when calling BlueOceanApi->put_pipeline_run: #{e}"
2566
+ puts "Error when calling BlueOceanApi->put_pipeline_run: #{e}"
2567
+ end
2568
+ ```
2569
+
2570
+ #### Using the put_pipeline_run_with_http_info variant
2571
+
2572
+ This returns an Array which contains the response data, status code and headers.
2573
+
2574
+ > <Array(<PipelineRun>, Integer, Hash)> put_pipeline_run_with_http_info(organization, pipeline, run, opts)
2575
+
2576
+ ```ruby
2577
+ begin
2578
+
2579
+ data, status_code, headers = api_instance.put_pipeline_run_with_http_info(organization, pipeline, run, opts)
2580
+ p status_code # => 2xx
2581
+ p headers # => { ... }
2582
+ p data # => <PipelineRun>
2583
+ rescue SwaggyJenkinsClient::ApiError => e
2584
+ puts "Error when calling BlueOceanApi->put_pipeline_run_with_http_info: #{e}"
1903
2585
  end
1904
2586
  ```
1905
2587
 
1906
2588
  ### Parameters
1907
2589
 
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]
2590
+ | Name | Type | Description | Notes |
2591
+ | ---- | ---- | ----------- | ----- |
2592
+ | **organization** | **String** | Name of the organization | |
2593
+ | **pipeline** | **String** | Name of the pipeline | |
2594
+ | **run** | **String** | Name of the run | |
2595
+ | **blocking** | **String** | Set to true to make blocking stop, default: false | [optional] |
2596
+ | **time_out_in_secs** | **Integer** | Timeout in seconds, default: 10 seconds | [optional] |
1915
2597
 
1916
2598
  ### Return type
1917
2599
 
@@ -1923,21 +2605,22 @@ Name | Type | Description | Notes
1923
2605
 
1924
2606
  ### HTTP request headers
1925
2607
 
1926
- - **Content-Type**: Not defined
1927
- - **Accept**: application/json
2608
+ - **Content-Type**: Not defined
2609
+ - **Accept**: application/json
1928
2610
 
1929
2611
 
2612
+ ## search
1930
2613
 
1931
- # **search**
1932
2614
  > String search(q)
1933
2615
 
1934
2616
 
1935
2617
 
1936
2618
  Search for any resource details
1937
2619
 
1938
- ### Example
2620
+ ### Examples
2621
+
1939
2622
  ```ruby
1940
- # load the gem
2623
+ require 'time'
1941
2624
  require 'swaggy_jenkins'
1942
2625
  # setup authorization
1943
2626
  SwaggyJenkinsClient.configure do |config|
@@ -1947,23 +2630,40 @@ SwaggyJenkinsClient.configure do |config|
1947
2630
  end
1948
2631
 
1949
2632
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
1950
-
1951
- q = "q_example" # String | Query string
1952
-
2633
+ q = 'q_example' # String | Query string
1953
2634
 
1954
2635
  begin
2636
+
1955
2637
  result = api_instance.search(q)
1956
2638
  p result
1957
2639
  rescue SwaggyJenkinsClient::ApiError => e
1958
- puts "Exception when calling BlueOceanApi->search: #{e}"
2640
+ puts "Error when calling BlueOceanApi->search: #{e}"
2641
+ end
2642
+ ```
2643
+
2644
+ #### Using the search_with_http_info variant
2645
+
2646
+ This returns an Array which contains the response data, status code and headers.
2647
+
2648
+ > <Array(String, Integer, Hash)> search_with_http_info(q)
2649
+
2650
+ ```ruby
2651
+ begin
2652
+
2653
+ data, status_code, headers = api_instance.search_with_http_info(q)
2654
+ p status_code # => 2xx
2655
+ p headers # => { ... }
2656
+ p data # => String
2657
+ rescue SwaggyJenkinsClient::ApiError => e
2658
+ puts "Error when calling BlueOceanApi->search_with_http_info: #{e}"
1959
2659
  end
1960
2660
  ```
1961
2661
 
1962
2662
  ### Parameters
1963
2663
 
1964
- Name | Type | Description | Notes
1965
- ------------- | ------------- | ------------- | -------------
1966
- **q** | **String**| Query string |
2664
+ | Name | Type | Description | Notes |
2665
+ | ---- | ---- | ----------- | ----- |
2666
+ | **q** | **String** | Query string | |
1967
2667
 
1968
2668
  ### Return type
1969
2669
 
@@ -1975,21 +2675,22 @@ Name | Type | Description | Notes
1975
2675
 
1976
2676
  ### HTTP request headers
1977
2677
 
1978
- - **Content-Type**: Not defined
1979
- - **Accept**: application/json
2678
+ - **Content-Type**: Not defined
2679
+ - **Accept**: application/json
1980
2680
 
1981
2681
 
2682
+ ## search_classes
1982
2683
 
1983
- # **search_classes**
1984
2684
  > String search_classes(q)
1985
2685
 
1986
2686
 
1987
2687
 
1988
2688
  Get classes details
1989
2689
 
1990
- ### Example
2690
+ ### Examples
2691
+
1991
2692
  ```ruby
1992
- # load the gem
2693
+ require 'time'
1993
2694
  require 'swaggy_jenkins'
1994
2695
  # setup authorization
1995
2696
  SwaggyJenkinsClient.configure do |config|
@@ -1999,23 +2700,40 @@ SwaggyJenkinsClient.configure do |config|
1999
2700
  end
2000
2701
 
2001
2702
  api_instance = SwaggyJenkinsClient::BlueOceanApi.new
2002
-
2003
- q = "q_example" # String | Query string containing an array of class names
2004
-
2703
+ q = 'q_example' # String | Query string containing an array of class names
2005
2704
 
2006
2705
  begin
2706
+
2007
2707
  result = api_instance.search_classes(q)
2008
2708
  p result
2009
2709
  rescue SwaggyJenkinsClient::ApiError => e
2010
- puts "Exception when calling BlueOceanApi->search_classes: #{e}"
2710
+ puts "Error when calling BlueOceanApi->search_classes: #{e}"
2711
+ end
2712
+ ```
2713
+
2714
+ #### Using the search_classes_with_http_info variant
2715
+
2716
+ This returns an Array which contains the response data, status code and headers.
2717
+
2718
+ > <Array(String, Integer, Hash)> search_classes_with_http_info(q)
2719
+
2720
+ ```ruby
2721
+ begin
2722
+
2723
+ data, status_code, headers = api_instance.search_classes_with_http_info(q)
2724
+ p status_code # => 2xx
2725
+ p headers # => { ... }
2726
+ p data # => String
2727
+ rescue SwaggyJenkinsClient::ApiError => e
2728
+ puts "Error when calling BlueOceanApi->search_classes_with_http_info: #{e}"
2011
2729
  end
2012
2730
  ```
2013
2731
 
2014
2732
  ### Parameters
2015
2733
 
2016
- Name | Type | Description | Notes
2017
- ------------- | ------------- | ------------- | -------------
2018
- **q** | **String**| Query string containing an array of class names |
2734
+ | Name | Type | Description | Notes |
2735
+ | ---- | ---- | ----------- | ----- |
2736
+ | **q** | **String** | Query string containing an array of class names | |
2019
2737
 
2020
2738
  ### Return type
2021
2739
 
@@ -2027,8 +2745,6 @@ Name | Type | Description | Notes
2027
2745
 
2028
2746
  ### HTTP request headers
2029
2747
 
2030
- - **Content-Type**: Not defined
2031
- - **Accept**: application/json
2032
-
2033
-
2748
+ - **Content-Type**: Not defined
2749
+ - **Accept**: application/json
2034
2750