swaggy_jenkins 0.0.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
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 +27 -0
  8. data/bin/coderay +27 -0
  9. data/bin/htmldiff +27 -0
  10. data/bin/ldiff +27 -0
  11. data/bin/pry +27 -0
  12. data/bin/rake +27 -0
  13. data/bin/rspec +27 -0
  14. data/bin/rubocop +27 -0
  15. data/bin/ruby-parse +27 -0
  16. data/bin/ruby-rewrite +27 -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 +98 -95
  105. data/lib/swaggy_jenkins/api_error.rb +22 -3
  106. data/lib/swaggy_jenkins/configuration.rb +93 -16
  107. data/lib/swaggy_jenkins/models/all_view.rb +60 -29
  108. data/lib/swaggy_jenkins/models/branch_impl.rb +77 -46
  109. data/lib/swaggy_jenkins/models/branch_impllinks.rb +63 -32
  110. data/lib/swaggy_jenkins/models/branch_implpermissions.rb +66 -35
  111. data/lib/swaggy_jenkins/models/cause_action.rb +59 -28
  112. data/lib/swaggy_jenkins/models/cause_user_id_cause.rb +64 -33
  113. data/lib/swaggy_jenkins/models/classes_by_class.rb +59 -28
  114. data/lib/swaggy_jenkins/models/clock_difference.rb +59 -28
  115. data/lib/swaggy_jenkins/models/computer_set.rb +65 -34
  116. data/lib/swaggy_jenkins/models/default_crumb_issuer.rb +61 -30
  117. data/lib/swaggy_jenkins/models/disk_space_monitor_descriptor_disk_space.rb +61 -30
  118. data/lib/swaggy_jenkins/models/empty_change_log_set.rb +59 -28
  119. data/lib/swaggy_jenkins/models/extension_class_container_impl1.rb +60 -29
  120. data/lib/swaggy_jenkins/models/extension_class_container_impl1links.rb +60 -29
  121. data/lib/swaggy_jenkins/models/extension_class_container_impl1map.rb +62 -31
  122. data/lib/swaggy_jenkins/models/extension_class_impl.rb +60 -29
  123. data/lib/swaggy_jenkins/models/extension_class_impllinks.rb +60 -29
  124. data/lib/swaggy_jenkins/models/favorite_impl.rb +60 -29
  125. data/lib/swaggy_jenkins/models/favorite_impllinks.rb +60 -29
  126. data/lib/swaggy_jenkins/models/free_style_build.rb +84 -53
  127. data/lib/swaggy_jenkins/models/free_style_project.rb +106 -75
  128. data/lib/swaggy_jenkins/models/free_style_projectactions.rb +58 -27
  129. data/lib/swaggy_jenkins/models/free_style_projecthealth_report.rb +64 -33
  130. data/lib/swaggy_jenkins/models/generic_resource.rb +66 -35
  131. data/lib/swaggy_jenkins/models/github_content.rb +66 -35
  132. data/lib/swaggy_jenkins/models/github_file.rb +59 -28
  133. data/lib/swaggy_jenkins/models/github_organization.rb +63 -32
  134. data/lib/swaggy_jenkins/models/github_organizationlinks.rb +61 -30
  135. data/lib/swaggy_jenkins/models/github_repositories.rb +66 -35
  136. data/lib/swaggy_jenkins/models/github_repositorieslinks.rb +60 -29
  137. data/lib/swaggy_jenkins/models/github_repository.rb +68 -37
  138. data/lib/swaggy_jenkins/models/github_repositorylinks.rb +60 -29
  139. data/lib/swaggy_jenkins/models/github_repositorypermissions.rb +64 -33
  140. data/lib/swaggy_jenkins/models/github_respository_container.rb +60 -29
  141. data/lib/swaggy_jenkins/models/github_respository_containerlinks.rb +60 -29
  142. data/lib/swaggy_jenkins/models/github_scm.rb +63 -32
  143. data/lib/swaggy_jenkins/models/github_scmlinks.rb +60 -29
  144. data/lib/swaggy_jenkins/models/hudson.rb +85 -54
  145. data/lib/swaggy_jenkins/models/hudson_master_computer.rb +90 -59
  146. data/lib/swaggy_jenkins/models/hudson_master_computerexecutors.rb +67 -36
  147. data/lib/swaggy_jenkins/models/hudson_master_computermonitor_data.rb +70 -39
  148. data/lib/swaggy_jenkins/models/hudsonassigned_labels.rb +58 -27
  149. data/lib/swaggy_jenkins/models/input_step_impl.rb +64 -33
  150. data/lib/swaggy_jenkins/models/input_step_impllinks.rb +60 -29
  151. data/lib/swaggy_jenkins/models/label1.rb +58 -27
  152. data/lib/swaggy_jenkins/models/link.rb +59 -28
  153. data/lib/swaggy_jenkins/models/list_view.rb +62 -31
  154. data/lib/swaggy_jenkins/models/multibranch_pipeline.rb +82 -51
  155. data/lib/swaggy_jenkins/models/null_scm.rb +58 -27
  156. data/lib/swaggy_jenkins/models/organisation.rb +59 -28
  157. data/lib/swaggy_jenkins/models/pipeline.rb +70 -39
  158. data/lib/swaggy_jenkins/models/pipeline_activity.rb +79 -48
  159. data/lib/swaggy_jenkins/models/pipeline_activityartifacts.rb +61 -30
  160. data/lib/swaggy_jenkins/models/pipeline_branchesitem.rb +72 -41
  161. data/lib/swaggy_jenkins/models/pipeline_branchesitemlatest_run.rb +78 -47
  162. data/lib/swaggy_jenkins/models/pipeline_branchesitempull_request.rb +63 -32
  163. data/lib/swaggy_jenkins/models/pipeline_branchesitempull_requestlinks.rb +60 -29
  164. data/lib/swaggy_jenkins/models/pipeline_folder_impl.rb +68 -37
  165. data/lib/swaggy_jenkins/models/pipeline_impl.rb +71 -40
  166. data/lib/swaggy_jenkins/models/pipeline_impllinks.rb +63 -32
  167. data/lib/swaggy_jenkins/models/pipeline_run.rb +79 -48
  168. data/lib/swaggy_jenkins/models/pipeline_run_impl.rb +79 -48
  169. data/lib/swaggy_jenkins/models/pipeline_run_impllinks.rb +64 -33
  170. data/lib/swaggy_jenkins/models/pipeline_run_node.rb +68 -37
  171. data/lib/swaggy_jenkins/models/pipeline_run_nodeedges.rb +59 -28
  172. data/lib/swaggy_jenkins/models/pipeline_runartifacts.rb +61 -30
  173. data/lib/swaggy_jenkins/models/pipeline_step_impl.rb +69 -38
  174. data/lib/swaggy_jenkins/models/pipeline_step_impllinks.rb +61 -30
  175. data/lib/swaggy_jenkins/models/pipelinelatest_run.rb +79 -48
  176. data/lib/swaggy_jenkins/models/pipelinelatest_runartifacts.rb +61 -30
  177. data/lib/swaggy_jenkins/models/queue.rb +59 -28
  178. data/lib/swaggy_jenkins/models/queue_blocked_item.rb +74 -43
  179. data/lib/swaggy_jenkins/models/queue_item_impl.rb +64 -33
  180. data/lib/swaggy_jenkins/models/queue_left_item.rb +75 -44
  181. data/lib/swaggy_jenkins/models/response_time_monitor_data.rb +60 -29
  182. data/lib/swaggy_jenkins/models/string_parameter_definition.rb +63 -32
  183. data/lib/swaggy_jenkins/models/string_parameter_value.rb +60 -29
  184. data/lib/swaggy_jenkins/models/swap_space_monitor_memory_usage2.rb +66 -35
  185. data/lib/swaggy_jenkins/models/unlabeled_load_statistics.rb +58 -27
  186. data/lib/swaggy_jenkins/models/user.rb +63 -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 +96 -274
  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
@@ -2,41 +2,42 @@
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_computer**](RemoteAccessApi.md#get_computer) | **GET** /computer/api/json |
8
- [**get_crumb**](RemoteAccessApi.md#get_crumb) | **GET** /crumbIssuer/api/json |
9
- [**get_jenkins**](RemoteAccessApi.md#get_jenkins) | **GET** /api/json |
10
- [**get_job**](RemoteAccessApi.md#get_job) | **GET** /job/{name}/api/json |
11
- [**get_job_config**](RemoteAccessApi.md#get_job_config) | **GET** /job/{name}/config.xml |
12
- [**get_job_last_build**](RemoteAccessApi.md#get_job_last_build) | **GET** /job/{name}/lastBuild/api/json |
13
- [**get_job_progressive_text**](RemoteAccessApi.md#get_job_progressive_text) | **GET** /job/{name}/{number}/logText/progressiveText |
14
- [**get_queue**](RemoteAccessApi.md#get_queue) | **GET** /queue/api/json |
15
- [**get_queue_item**](RemoteAccessApi.md#get_queue_item) | **GET** /queue/item/{number}/api/json |
16
- [**get_view**](RemoteAccessApi.md#get_view) | **GET** /view/{name}/api/json |
17
- [**get_view_config**](RemoteAccessApi.md#get_view_config) | **GET** /view/{name}/config.xml |
18
- [**head_jenkins**](RemoteAccessApi.md#head_jenkins) | **HEAD** /api/json |
19
- [**post_create_item**](RemoteAccessApi.md#post_create_item) | **POST** /createItem |
20
- [**post_create_view**](RemoteAccessApi.md#post_create_view) | **POST** /createView |
21
- [**post_job_build**](RemoteAccessApi.md#post_job_build) | **POST** /job/{name}/build |
22
- [**post_job_config**](RemoteAccessApi.md#post_job_config) | **POST** /job/{name}/config.xml |
23
- [**post_job_delete**](RemoteAccessApi.md#post_job_delete) | **POST** /job/{name}/doDelete |
24
- [**post_job_disable**](RemoteAccessApi.md#post_job_disable) | **POST** /job/{name}/disable |
25
- [**post_job_enable**](RemoteAccessApi.md#post_job_enable) | **POST** /job/{name}/enable |
26
- [**post_job_last_build_stop**](RemoteAccessApi.md#post_job_last_build_stop) | **POST** /job/{name}/lastBuild/stop |
27
- [**post_view_config**](RemoteAccessApi.md#post_view_config) | **POST** /view/{name}/config.xml |
28
-
29
-
30
- # **get_computer**
31
- > ComputerSet get_computer(depth)
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_computer**](RemoteAccessApi.md#get_computer) | **GET** /computer/api/json | |
8
+ | [**get_jenkins**](RemoteAccessApi.md#get_jenkins) | **GET** /api/json | |
9
+ | [**get_job**](RemoteAccessApi.md#get_job) | **GET** /job/{name}/api/json | |
10
+ | [**get_job_config**](RemoteAccessApi.md#get_job_config) | **GET** /job/{name}/config.xml | |
11
+ | [**get_job_last_build**](RemoteAccessApi.md#get_job_last_build) | **GET** /job/{name}/lastBuild/api/json | |
12
+ | [**get_job_progressive_text**](RemoteAccessApi.md#get_job_progressive_text) | **GET** /job/{name}/{number}/logText/progressiveText | |
13
+ | [**get_queue**](RemoteAccessApi.md#get_queue) | **GET** /queue/api/json | |
14
+ | [**get_queue_item**](RemoteAccessApi.md#get_queue_item) | **GET** /queue/item/{number}/api/json | |
15
+ | [**get_view**](RemoteAccessApi.md#get_view) | **GET** /view/{name}/api/json | |
16
+ | [**get_view_config**](RemoteAccessApi.md#get_view_config) | **GET** /view/{name}/config.xml | |
17
+ | [**head_jenkins**](RemoteAccessApi.md#head_jenkins) | **HEAD** /api/json | |
18
+ | [**post_create_item**](RemoteAccessApi.md#post_create_item) | **POST** /createItem | |
19
+ | [**post_create_view**](RemoteAccessApi.md#post_create_view) | **POST** /createView | |
20
+ | [**post_job_build**](RemoteAccessApi.md#post_job_build) | **POST** /job/{name}/build | |
21
+ | [**post_job_config**](RemoteAccessApi.md#post_job_config) | **POST** /job/{name}/config.xml | |
22
+ | [**post_job_delete**](RemoteAccessApi.md#post_job_delete) | **POST** /job/{name}/doDelete | |
23
+ | [**post_job_disable**](RemoteAccessApi.md#post_job_disable) | **POST** /job/{name}/disable | |
24
+ | [**post_job_enable**](RemoteAccessApi.md#post_job_enable) | **POST** /job/{name}/enable | |
25
+ | [**post_job_last_build_stop**](RemoteAccessApi.md#post_job_last_build_stop) | **POST** /job/{name}/lastBuild/stop | |
26
+ | [**post_view_config**](RemoteAccessApi.md#post_view_config) | **POST** /view/{name}/config.xml | |
27
+
28
+
29
+ ## get_computer
30
+
31
+ > <ComputerSet> get_computer(depth)
32
32
 
33
33
 
34
34
 
35
35
  Retrieve computer details
36
36
 
37
- ### Example
37
+ ### Examples
38
+
38
39
  ```ruby
39
- # load the gem
40
+ require 'time'
40
41
  require 'swaggy_jenkins'
41
42
  # setup authorization
42
43
  SwaggyJenkinsClient.configure do |config|
@@ -46,73 +47,44 @@ SwaggyJenkinsClient.configure do |config|
46
47
  end
47
48
 
48
49
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
49
-
50
50
  depth = 56 # Integer | Recursion depth in response model
51
51
 
52
-
53
52
  begin
53
+
54
54
  result = api_instance.get_computer(depth)
55
55
  p result
56
56
  rescue SwaggyJenkinsClient::ApiError => e
57
- puts "Exception when calling RemoteAccessApi->get_computer: #{e}"
57
+ puts "Error when calling RemoteAccessApi->get_computer: #{e}"
58
58
  end
59
59
  ```
60
60
 
61
- ### Parameters
62
-
63
- Name | Type | Description | Notes
64
- ------------- | ------------- | ------------- | -------------
65
- **depth** | **Integer**| Recursion depth in response model |
66
-
67
- ### Return type
68
-
69
- [**ComputerSet**](ComputerSet.md)
70
-
71
- ### Authorization
72
-
73
- [jenkins_auth](../README.md#jenkins_auth)
74
-
75
- ### HTTP request headers
76
-
77
- - **Content-Type**: Not defined
78
- - **Accept**: application/json
79
-
80
-
81
-
82
- # **get_crumb**
83
- > DefaultCrumbIssuer get_crumb
61
+ #### Using the get_computer_with_http_info variant
84
62
 
63
+ This returns an Array which contains the response data, status code and headers.
85
64
 
65
+ > <Array(<ComputerSet>, Integer, Hash)> get_computer_with_http_info(depth)
86
66
 
87
- Retrieve CSRF protection token
88
-
89
- ### Example
90
67
  ```ruby
91
- # load the gem
92
- require 'swaggy_jenkins'
93
- # setup authorization
94
- SwaggyJenkinsClient.configure do |config|
95
- # Configure HTTP basic authorization: jenkins_auth
96
- config.username = 'YOUR USERNAME'
97
- config.password = 'YOUR PASSWORD'
98
- end
99
-
100
- api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
101
-
102
68
  begin
103
- result = api_instance.get_crumb
104
- p result
69
+
70
+ data, status_code, headers = api_instance.get_computer_with_http_info(depth)
71
+ p status_code # => 2xx
72
+ p headers # => { ... }
73
+ p data # => <ComputerSet>
105
74
  rescue SwaggyJenkinsClient::ApiError => e
106
- puts "Exception when calling RemoteAccessApi->get_crumb: #{e}"
75
+ puts "Error when calling RemoteAccessApi->get_computer_with_http_info: #{e}"
107
76
  end
108
77
  ```
109
78
 
110
79
  ### Parameters
111
- This endpoint does not need any parameter.
80
+
81
+ | Name | Type | Description | Notes |
82
+ | ---- | ---- | ----------- | ----- |
83
+ | **depth** | **Integer** | Recursion depth in response model | |
112
84
 
113
85
  ### Return type
114
86
 
115
- [**DefaultCrumbIssuer**](DefaultCrumbIssuer.md)
87
+ [**ComputerSet**](ComputerSet.md)
116
88
 
117
89
  ### Authorization
118
90
 
@@ -120,21 +92,22 @@ This endpoint does not need any parameter.
120
92
 
121
93
  ### HTTP request headers
122
94
 
123
- - **Content-Type**: Not defined
124
- - **Accept**: application/json
95
+ - **Content-Type**: Not defined
96
+ - **Accept**: application/json
125
97
 
126
98
 
99
+ ## get_jenkins
127
100
 
128
- # **get_jenkins**
129
- > Hudson get_jenkins
101
+ > <Hudson> get_jenkins
130
102
 
131
103
 
132
104
 
133
105
  Retrieve Jenkins details
134
106
 
135
- ### Example
107
+ ### Examples
108
+
136
109
  ```ruby
137
- # load the gem
110
+ require 'time'
138
111
  require 'swaggy_jenkins'
139
112
  # setup authorization
140
113
  SwaggyJenkinsClient.configure do |config|
@@ -146,14 +119,34 @@ end
146
119
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
147
120
 
148
121
  begin
122
+
149
123
  result = api_instance.get_jenkins
150
124
  p result
151
125
  rescue SwaggyJenkinsClient::ApiError => e
152
- puts "Exception when calling RemoteAccessApi->get_jenkins: #{e}"
126
+ puts "Error when calling RemoteAccessApi->get_jenkins: #{e}"
127
+ end
128
+ ```
129
+
130
+ #### Using the get_jenkins_with_http_info variant
131
+
132
+ This returns an Array which contains the response data, status code and headers.
133
+
134
+ > <Array(<Hudson>, Integer, Hash)> get_jenkins_with_http_info
135
+
136
+ ```ruby
137
+ begin
138
+
139
+ data, status_code, headers = api_instance.get_jenkins_with_http_info
140
+ p status_code # => 2xx
141
+ p headers # => { ... }
142
+ p data # => <Hudson>
143
+ rescue SwaggyJenkinsClient::ApiError => e
144
+ puts "Error when calling RemoteAccessApi->get_jenkins_with_http_info: #{e}"
153
145
  end
154
146
  ```
155
147
 
156
148
  ### Parameters
149
+
157
150
  This endpoint does not need any parameter.
158
151
 
159
152
  ### Return type
@@ -166,21 +159,22 @@ This endpoint does not need any parameter.
166
159
 
167
160
  ### HTTP request headers
168
161
 
169
- - **Content-Type**: Not defined
170
- - **Accept**: application/json
162
+ - **Content-Type**: Not defined
163
+ - **Accept**: application/json
171
164
 
172
165
 
166
+ ## get_job
173
167
 
174
- # **get_job**
175
- > FreeStyleProject get_job(name, )
168
+ > <FreeStyleProject> get_job(name)
176
169
 
177
170
 
178
171
 
179
172
  Retrieve job details
180
173
 
181
- ### Example
174
+ ### Examples
175
+
182
176
  ```ruby
183
- # load the gem
177
+ require 'time'
184
178
  require 'swaggy_jenkins'
185
179
  # setup authorization
186
180
  SwaggyJenkinsClient.configure do |config|
@@ -190,23 +184,40 @@ SwaggyJenkinsClient.configure do |config|
190
184
  end
191
185
 
192
186
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
187
+ name = 'name_example' # String | Name of the job
188
+
189
+ begin
190
+
191
+ result = api_instance.get_job(name)
192
+ p result
193
+ rescue SwaggyJenkinsClient::ApiError => e
194
+ puts "Error when calling RemoteAccessApi->get_job: #{e}"
195
+ end
196
+ ```
193
197
 
194
- name = "name_example" # String | Name of the job
198
+ #### Using the get_job_with_http_info variant
195
199
 
200
+ This returns an Array which contains the response data, status code and headers.
196
201
 
202
+ > <Array(<FreeStyleProject>, Integer, Hash)> get_job_with_http_info(name)
203
+
204
+ ```ruby
197
205
  begin
198
- result = api_instance.get_job(name, )
199
- p result
206
+
207
+ data, status_code, headers = api_instance.get_job_with_http_info(name)
208
+ p status_code # => 2xx
209
+ p headers # => { ... }
210
+ p data # => <FreeStyleProject>
200
211
  rescue SwaggyJenkinsClient::ApiError => e
201
- puts "Exception when calling RemoteAccessApi->get_job: #{e}"
212
+ puts "Error when calling RemoteAccessApi->get_job_with_http_info: #{e}"
202
213
  end
203
214
  ```
204
215
 
205
216
  ### Parameters
206
217
 
207
- Name | Type | Description | Notes
208
- ------------- | ------------- | ------------- | -------------
209
- **name** | **String**| Name of the job |
218
+ | Name | Type | Description | Notes |
219
+ | ---- | ---- | ----------- | ----- |
220
+ | **name** | **String** | Name of the job | |
210
221
 
211
222
  ### Return type
212
223
 
@@ -218,21 +229,22 @@ Name | Type | Description | Notes
218
229
 
219
230
  ### HTTP request headers
220
231
 
221
- - **Content-Type**: Not defined
222
- - **Accept**: application/json
232
+ - **Content-Type**: Not defined
233
+ - **Accept**: application/json
223
234
 
224
235
 
236
+ ## get_job_config
225
237
 
226
- # **get_job_config**
227
- > String get_job_config(name, )
238
+ > String get_job_config(name)
228
239
 
229
240
 
230
241
 
231
242
  Retrieve job configuration
232
243
 
233
- ### Example
244
+ ### Examples
245
+
234
246
  ```ruby
235
- # load the gem
247
+ require 'time'
236
248
  require 'swaggy_jenkins'
237
249
  # setup authorization
238
250
  SwaggyJenkinsClient.configure do |config|
@@ -242,23 +254,40 @@ SwaggyJenkinsClient.configure do |config|
242
254
  end
243
255
 
244
256
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
257
+ name = 'name_example' # String | Name of the job
258
+
259
+ begin
260
+
261
+ result = api_instance.get_job_config(name)
262
+ p result
263
+ rescue SwaggyJenkinsClient::ApiError => e
264
+ puts "Error when calling RemoteAccessApi->get_job_config: #{e}"
265
+ end
266
+ ```
267
+
268
+ #### Using the get_job_config_with_http_info variant
245
269
 
246
- name = "name_example" # String | Name of the job
270
+ This returns an Array which contains the response data, status code and headers.
247
271
 
272
+ > <Array(String, Integer, Hash)> get_job_config_with_http_info(name)
248
273
 
274
+ ```ruby
249
275
  begin
250
- result = api_instance.get_job_config(name, )
251
- p result
276
+
277
+ data, status_code, headers = api_instance.get_job_config_with_http_info(name)
278
+ p status_code # => 2xx
279
+ p headers # => { ... }
280
+ p data # => String
252
281
  rescue SwaggyJenkinsClient::ApiError => e
253
- puts "Exception when calling RemoteAccessApi->get_job_config: #{e}"
282
+ puts "Error when calling RemoteAccessApi->get_job_config_with_http_info: #{e}"
254
283
  end
255
284
  ```
256
285
 
257
286
  ### Parameters
258
287
 
259
- Name | Type | Description | Notes
260
- ------------- | ------------- | ------------- | -------------
261
- **name** | **String**| Name of the job |
288
+ | Name | Type | Description | Notes |
289
+ | ---- | ---- | ----------- | ----- |
290
+ | **name** | **String** | Name of the job | |
262
291
 
263
292
  ### Return type
264
293
 
@@ -270,21 +299,22 @@ Name | Type | Description | Notes
270
299
 
271
300
  ### HTTP request headers
272
301
 
273
- - **Content-Type**: Not defined
274
- - **Accept**: text/xml
302
+ - **Content-Type**: Not defined
303
+ - **Accept**: text/xml
275
304
 
276
305
 
306
+ ## get_job_last_build
277
307
 
278
- # **get_job_last_build**
279
- > FreeStyleBuild get_job_last_build(name, )
308
+ > <FreeStyleBuild> get_job_last_build(name)
280
309
 
281
310
 
282
311
 
283
312
  Retrieve job's last build details
284
313
 
285
- ### Example
314
+ ### Examples
315
+
286
316
  ```ruby
287
- # load the gem
317
+ require 'time'
288
318
  require 'swaggy_jenkins'
289
319
  # setup authorization
290
320
  SwaggyJenkinsClient.configure do |config|
@@ -294,23 +324,40 @@ SwaggyJenkinsClient.configure do |config|
294
324
  end
295
325
 
296
326
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
327
+ name = 'name_example' # String | Name of the job
297
328
 
298
- name = "name_example" # String | Name of the job
329
+ begin
330
+
331
+ result = api_instance.get_job_last_build(name)
332
+ p result
333
+ rescue SwaggyJenkinsClient::ApiError => e
334
+ puts "Error when calling RemoteAccessApi->get_job_last_build: #{e}"
335
+ end
336
+ ```
299
337
 
338
+ #### Using the get_job_last_build_with_http_info variant
300
339
 
340
+ This returns an Array which contains the response data, status code and headers.
341
+
342
+ > <Array(<FreeStyleBuild>, Integer, Hash)> get_job_last_build_with_http_info(name)
343
+
344
+ ```ruby
301
345
  begin
302
- result = api_instance.get_job_last_build(name, )
303
- p result
346
+
347
+ data, status_code, headers = api_instance.get_job_last_build_with_http_info(name)
348
+ p status_code # => 2xx
349
+ p headers # => { ... }
350
+ p data # => <FreeStyleBuild>
304
351
  rescue SwaggyJenkinsClient::ApiError => e
305
- puts "Exception when calling RemoteAccessApi->get_job_last_build: #{e}"
352
+ puts "Error when calling RemoteAccessApi->get_job_last_build_with_http_info: #{e}"
306
353
  end
307
354
  ```
308
355
 
309
356
  ### Parameters
310
357
 
311
- Name | Type | Description | Notes
312
- ------------- | ------------- | ------------- | -------------
313
- **name** | **String**| Name of the job |
358
+ | Name | Type | Description | Notes |
359
+ | ---- | ---- | ----------- | ----- |
360
+ | **name** | **String** | Name of the job | |
314
361
 
315
362
  ### Return type
316
363
 
@@ -322,21 +369,22 @@ Name | Type | Description | Notes
322
369
 
323
370
  ### HTTP request headers
324
371
 
325
- - **Content-Type**: Not defined
326
- - **Accept**: application/json
372
+ - **Content-Type**: Not defined
373
+ - **Accept**: application/json
327
374
 
328
375
 
376
+ ## get_job_progressive_text
329
377
 
330
- # **get_job_progressive_text**
331
378
  > get_job_progressive_text(name, number, start)
332
379
 
333
380
 
334
381
 
335
382
  Retrieve job's build progressive text output
336
383
 
337
- ### Example
384
+ ### Examples
385
+
338
386
  ```ruby
339
- # load the gem
387
+ require 'time'
340
388
  require 'swaggy_jenkins'
341
389
  # setup authorization
342
390
  SwaggyJenkinsClient.configure do |config|
@@ -346,28 +394,43 @@ SwaggyJenkinsClient.configure do |config|
346
394
  end
347
395
 
348
396
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
397
+ name = 'name_example' # String | Name of the job
398
+ number = 'number_example' # String | Build number
399
+ start = 'start_example' # String | Starting point of progressive text output
349
400
 
350
- name = "name_example" # String | Name of the job
401
+ begin
402
+
403
+ api_instance.get_job_progressive_text(name, number, start)
404
+ rescue SwaggyJenkinsClient::ApiError => e
405
+ puts "Error when calling RemoteAccessApi->get_job_progressive_text: #{e}"
406
+ end
407
+ ```
351
408
 
352
- number = "number_example" # String | Build number
409
+ #### Using the get_job_progressive_text_with_http_info variant
353
410
 
354
- start = "start_example" # String | Starting point of progressive text output
411
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
355
412
 
413
+ > <Array(nil, Integer, Hash)> get_job_progressive_text_with_http_info(name, number, start)
356
414
 
415
+ ```ruby
357
416
  begin
358
- api_instance.get_job_progressive_text(name, number, start)
417
+
418
+ data, status_code, headers = api_instance.get_job_progressive_text_with_http_info(name, number, start)
419
+ p status_code # => 2xx
420
+ p headers # => { ... }
421
+ p data # => nil
359
422
  rescue SwaggyJenkinsClient::ApiError => e
360
- puts "Exception when calling RemoteAccessApi->get_job_progressive_text: #{e}"
423
+ puts "Error when calling RemoteAccessApi->get_job_progressive_text_with_http_info: #{e}"
361
424
  end
362
425
  ```
363
426
 
364
427
  ### Parameters
365
428
 
366
- Name | Type | Description | Notes
367
- ------------- | ------------- | ------------- | -------------
368
- **name** | **String**| Name of the job |
369
- **number** | **String**| Build number |
370
- **start** | **String**| Starting point of progressive text output |
429
+ | Name | Type | Description | Notes |
430
+ | ---- | ---- | ----------- | ----- |
431
+ | **name** | **String** | Name of the job | |
432
+ | **number** | **String** | Build number | |
433
+ | **start** | **String** | Starting point of progressive text output | |
371
434
 
372
435
  ### Return type
373
436
 
@@ -379,21 +442,22 @@ nil (empty response body)
379
442
 
380
443
  ### HTTP request headers
381
444
 
382
- - **Content-Type**: Not defined
383
- - **Accept**: Not defined
445
+ - **Content-Type**: Not defined
446
+ - **Accept**: Not defined
384
447
 
385
448
 
449
+ ## get_queue
386
450
 
387
- # **get_queue**
388
- > Queue get_queue
451
+ > <Queue> get_queue
389
452
 
390
453
 
391
454
 
392
455
  Retrieve queue details
393
456
 
394
- ### Example
457
+ ### Examples
458
+
395
459
  ```ruby
396
- # load the gem
460
+ require 'time'
397
461
  require 'swaggy_jenkins'
398
462
  # setup authorization
399
463
  SwaggyJenkinsClient.configure do |config|
@@ -405,14 +469,34 @@ end
405
469
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
406
470
 
407
471
  begin
472
+
408
473
  result = api_instance.get_queue
409
474
  p result
410
475
  rescue SwaggyJenkinsClient::ApiError => e
411
- puts "Exception when calling RemoteAccessApi->get_queue: #{e}"
476
+ puts "Error when calling RemoteAccessApi->get_queue: #{e}"
477
+ end
478
+ ```
479
+
480
+ #### Using the get_queue_with_http_info variant
481
+
482
+ This returns an Array which contains the response data, status code and headers.
483
+
484
+ > <Array(<Queue>, Integer, Hash)> get_queue_with_http_info
485
+
486
+ ```ruby
487
+ begin
488
+
489
+ data, status_code, headers = api_instance.get_queue_with_http_info
490
+ p status_code # => 2xx
491
+ p headers # => { ... }
492
+ p data # => <Queue>
493
+ rescue SwaggyJenkinsClient::ApiError => e
494
+ puts "Error when calling RemoteAccessApi->get_queue_with_http_info: #{e}"
412
495
  end
413
496
  ```
414
497
 
415
498
  ### Parameters
499
+
416
500
  This endpoint does not need any parameter.
417
501
 
418
502
  ### Return type
@@ -425,21 +509,22 @@ This endpoint does not need any parameter.
425
509
 
426
510
  ### HTTP request headers
427
511
 
428
- - **Content-Type**: Not defined
429
- - **Accept**: application/json
512
+ - **Content-Type**: Not defined
513
+ - **Accept**: application/json
430
514
 
431
515
 
516
+ ## get_queue_item
432
517
 
433
- # **get_queue_item**
434
- > Queue get_queue_item(number)
518
+ > <Queue> get_queue_item(number)
435
519
 
436
520
 
437
521
 
438
522
  Retrieve queued item details
439
523
 
440
- ### Example
524
+ ### Examples
525
+
441
526
  ```ruby
442
- # load the gem
527
+ require 'time'
443
528
  require 'swaggy_jenkins'
444
529
  # setup authorization
445
530
  SwaggyJenkinsClient.configure do |config|
@@ -449,23 +534,40 @@ SwaggyJenkinsClient.configure do |config|
449
534
  end
450
535
 
451
536
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
452
-
453
- number = "number_example" # String | Queue number
454
-
537
+ number = 'number_example' # String | Queue number
455
538
 
456
539
  begin
540
+
457
541
  result = api_instance.get_queue_item(number)
458
542
  p result
459
543
  rescue SwaggyJenkinsClient::ApiError => e
460
- puts "Exception when calling RemoteAccessApi->get_queue_item: #{e}"
544
+ puts "Error when calling RemoteAccessApi->get_queue_item: #{e}"
545
+ end
546
+ ```
547
+
548
+ #### Using the get_queue_item_with_http_info variant
549
+
550
+ This returns an Array which contains the response data, status code and headers.
551
+
552
+ > <Array(<Queue>, Integer, Hash)> get_queue_item_with_http_info(number)
553
+
554
+ ```ruby
555
+ begin
556
+
557
+ data, status_code, headers = api_instance.get_queue_item_with_http_info(number)
558
+ p status_code # => 2xx
559
+ p headers # => { ... }
560
+ p data # => <Queue>
561
+ rescue SwaggyJenkinsClient::ApiError => e
562
+ puts "Error when calling RemoteAccessApi->get_queue_item_with_http_info: #{e}"
461
563
  end
462
564
  ```
463
565
 
464
566
  ### Parameters
465
567
 
466
- Name | Type | Description | Notes
467
- ------------- | ------------- | ------------- | -------------
468
- **number** | **String**| Queue number |
568
+ | Name | Type | Description | Notes |
569
+ | ---- | ---- | ----------- | ----- |
570
+ | **number** | **String** | Queue number | |
469
571
 
470
572
  ### Return type
471
573
 
@@ -477,21 +579,22 @@ Name | Type | Description | Notes
477
579
 
478
580
  ### HTTP request headers
479
581
 
480
- - **Content-Type**: Not defined
481
- - **Accept**: application/json
582
+ - **Content-Type**: Not defined
583
+ - **Accept**: application/json
482
584
 
483
585
 
586
+ ## get_view
484
587
 
485
- # **get_view**
486
- > ListView get_view(name, )
588
+ > <ListView> get_view(name)
487
589
 
488
590
 
489
591
 
490
592
  Retrieve view details
491
593
 
492
- ### Example
594
+ ### Examples
595
+
493
596
  ```ruby
494
- # load the gem
597
+ require 'time'
495
598
  require 'swaggy_jenkins'
496
599
  # setup authorization
497
600
  SwaggyJenkinsClient.configure do |config|
@@ -501,23 +604,40 @@ SwaggyJenkinsClient.configure do |config|
501
604
  end
502
605
 
503
606
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
607
+ name = 'name_example' # String | Name of the view
608
+
609
+ begin
610
+
611
+ result = api_instance.get_view(name)
612
+ p result
613
+ rescue SwaggyJenkinsClient::ApiError => e
614
+ puts "Error when calling RemoteAccessApi->get_view: #{e}"
615
+ end
616
+ ```
504
617
 
505
- name = "name_example" # String | Name of the view
618
+ #### Using the get_view_with_http_info variant
506
619
 
620
+ This returns an Array which contains the response data, status code and headers.
507
621
 
622
+ > <Array(<ListView>, Integer, Hash)> get_view_with_http_info(name)
623
+
624
+ ```ruby
508
625
  begin
509
- result = api_instance.get_view(name, )
510
- p result
626
+
627
+ data, status_code, headers = api_instance.get_view_with_http_info(name)
628
+ p status_code # => 2xx
629
+ p headers # => { ... }
630
+ p data # => <ListView>
511
631
  rescue SwaggyJenkinsClient::ApiError => e
512
- puts "Exception when calling RemoteAccessApi->get_view: #{e}"
632
+ puts "Error when calling RemoteAccessApi->get_view_with_http_info: #{e}"
513
633
  end
514
634
  ```
515
635
 
516
636
  ### Parameters
517
637
 
518
- Name | Type | Description | Notes
519
- ------------- | ------------- | ------------- | -------------
520
- **name** | **String**| Name of the view |
638
+ | Name | Type | Description | Notes |
639
+ | ---- | ---- | ----------- | ----- |
640
+ | **name** | **String** | Name of the view | |
521
641
 
522
642
  ### Return type
523
643
 
@@ -529,21 +649,22 @@ Name | Type | Description | Notes
529
649
 
530
650
  ### HTTP request headers
531
651
 
532
- - **Content-Type**: Not defined
533
- - **Accept**: application/json
652
+ - **Content-Type**: Not defined
653
+ - **Accept**: application/json
534
654
 
535
655
 
656
+ ## get_view_config
536
657
 
537
- # **get_view_config**
538
- > String get_view_config(name, )
658
+ > String get_view_config(name)
539
659
 
540
660
 
541
661
 
542
662
  Retrieve view configuration
543
663
 
544
- ### Example
664
+ ### Examples
665
+
545
666
  ```ruby
546
- # load the gem
667
+ require 'time'
547
668
  require 'swaggy_jenkins'
548
669
  # setup authorization
549
670
  SwaggyJenkinsClient.configure do |config|
@@ -553,23 +674,40 @@ SwaggyJenkinsClient.configure do |config|
553
674
  end
554
675
 
555
676
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
677
+ name = 'name_example' # String | Name of the view
678
+
679
+ begin
680
+
681
+ result = api_instance.get_view_config(name)
682
+ p result
683
+ rescue SwaggyJenkinsClient::ApiError => e
684
+ puts "Error when calling RemoteAccessApi->get_view_config: #{e}"
685
+ end
686
+ ```
687
+
688
+ #### Using the get_view_config_with_http_info variant
556
689
 
557
- name = "name_example" # String | Name of the view
690
+ This returns an Array which contains the response data, status code and headers.
558
691
 
692
+ > <Array(String, Integer, Hash)> get_view_config_with_http_info(name)
559
693
 
694
+ ```ruby
560
695
  begin
561
- result = api_instance.get_view_config(name, )
562
- p result
696
+
697
+ data, status_code, headers = api_instance.get_view_config_with_http_info(name)
698
+ p status_code # => 2xx
699
+ p headers # => { ... }
700
+ p data # => String
563
701
  rescue SwaggyJenkinsClient::ApiError => e
564
- puts "Exception when calling RemoteAccessApi->get_view_config: #{e}"
702
+ puts "Error when calling RemoteAccessApi->get_view_config_with_http_info: #{e}"
565
703
  end
566
704
  ```
567
705
 
568
706
  ### Parameters
569
707
 
570
- Name | Type | Description | Notes
571
- ------------- | ------------- | ------------- | -------------
572
- **name** | **String**| Name of the view |
708
+ | Name | Type | Description | Notes |
709
+ | ---- | ---- | ----------- | ----- |
710
+ | **name** | **String** | Name of the view | |
573
711
 
574
712
  ### Return type
575
713
 
@@ -581,21 +719,22 @@ Name | Type | Description | Notes
581
719
 
582
720
  ### HTTP request headers
583
721
 
584
- - **Content-Type**: Not defined
585
- - **Accept**: text/xml
722
+ - **Content-Type**: Not defined
723
+ - **Accept**: text/xml
586
724
 
587
725
 
726
+ ## head_jenkins
588
727
 
589
- # **head_jenkins**
590
728
  > head_jenkins
591
729
 
592
730
 
593
731
 
594
732
  Retrieve Jenkins headers
595
733
 
596
- ### Example
734
+ ### Examples
735
+
597
736
  ```ruby
598
- # load the gem
737
+ require 'time'
599
738
  require 'swaggy_jenkins'
600
739
  # setup authorization
601
740
  SwaggyJenkinsClient.configure do |config|
@@ -607,13 +746,33 @@ end
607
746
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
608
747
 
609
748
  begin
749
+
610
750
  api_instance.head_jenkins
611
751
  rescue SwaggyJenkinsClient::ApiError => e
612
- puts "Exception when calling RemoteAccessApi->head_jenkins: #{e}"
752
+ puts "Error when calling RemoteAccessApi->head_jenkins: #{e}"
753
+ end
754
+ ```
755
+
756
+ #### Using the head_jenkins_with_http_info variant
757
+
758
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
759
+
760
+ > <Array(nil, Integer, Hash)> head_jenkins_with_http_info
761
+
762
+ ```ruby
763
+ begin
764
+
765
+ data, status_code, headers = api_instance.head_jenkins_with_http_info
766
+ p status_code # => 2xx
767
+ p headers # => { ... }
768
+ p data # => nil
769
+ rescue SwaggyJenkinsClient::ApiError => e
770
+ puts "Error when calling RemoteAccessApi->head_jenkins_with_http_info: #{e}"
613
771
  end
614
772
  ```
615
773
 
616
774
  ### Parameters
775
+
617
776
  This endpoint does not need any parameter.
618
777
 
619
778
  ### Return type
@@ -626,21 +785,22 @@ nil (empty response body)
626
785
 
627
786
  ### HTTP request headers
628
787
 
629
- - **Content-Type**: Not defined
630
- - **Accept**: Not defined
788
+ - **Content-Type**: Not defined
789
+ - **Accept**: Not defined
631
790
 
632
791
 
792
+ ## post_create_item
633
793
 
634
- # **post_create_item**
635
794
  > post_create_item(name, opts)
636
795
 
637
796
 
638
797
 
639
798
  Create a new job using job configuration, or copied from an existing job
640
799
 
641
- ### Example
800
+ ### Examples
801
+
642
802
  ```ruby
643
- # load the gem
803
+ require 'time'
644
804
  require 'swaggy_jenkins'
645
805
  # setup authorization
646
806
  SwaggyJenkinsClient.configure do |config|
@@ -650,34 +810,51 @@ SwaggyJenkinsClient.configure do |config|
650
810
  end
651
811
 
652
812
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
653
-
654
- name = "name_example" # String | Name of the new job
655
-
656
- opts = {
657
- from: "from_example", # String | Existing job to copy from
658
- mode: "mode_example", # String | Set to 'copy' for copying an existing job
659
- body: "body_example", # String | Job configuration in config.xml format
660
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
661
- content_type: "content_type_example" # String | Content type header application/xml
813
+ name = 'name_example' # String | Name of the new job
814
+ opts = {
815
+ from: 'from_example', # String | Existing job to copy from
816
+ mode: 'mode_example', # String | Set to 'copy' for copying an existing job
817
+ jenkins_crumb: 'jenkins_crumb_example', # String | CSRF protection token
818
+ content_type: 'content_type_example', # String | Content type header application/xml
819
+ body: 'body_example' # String | Job configuration in config.xml format
662
820
  }
663
821
 
664
822
  begin
823
+
665
824
  api_instance.post_create_item(name, opts)
666
825
  rescue SwaggyJenkinsClient::ApiError => e
667
- puts "Exception when calling RemoteAccessApi->post_create_item: #{e}"
826
+ puts "Error when calling RemoteAccessApi->post_create_item: #{e}"
827
+ end
828
+ ```
829
+
830
+ #### Using the post_create_item_with_http_info variant
831
+
832
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
833
+
834
+ > <Array(nil, Integer, Hash)> post_create_item_with_http_info(name, opts)
835
+
836
+ ```ruby
837
+ begin
838
+
839
+ data, status_code, headers = api_instance.post_create_item_with_http_info(name, opts)
840
+ p status_code # => 2xx
841
+ p headers # => { ... }
842
+ p data # => nil
843
+ rescue SwaggyJenkinsClient::ApiError => e
844
+ puts "Error when calling RemoteAccessApi->post_create_item_with_http_info: #{e}"
668
845
  end
669
846
  ```
670
847
 
671
848
  ### Parameters
672
849
 
673
- Name | Type | Description | Notes
674
- ------------- | ------------- | ------------- | -------------
675
- **name** | **String**| Name of the new job |
676
- **from** | **String**| Existing job to copy from | [optional]
677
- **mode** | **String**| Set to &#39;copy&#39; for copying an existing job | [optional]
678
- **body** | **String**| Job configuration in config.xml format | [optional]
679
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
680
- **content_type** | **String**| Content type header application/xml | [optional]
850
+ | Name | Type | Description | Notes |
851
+ | ---- | ---- | ----------- | ----- |
852
+ | **name** | **String** | Name of the new job | |
853
+ | **from** | **String** | Existing job to copy from | [optional] |
854
+ | **mode** | **String** | Set to &#39;copy&#39; for copying an existing job | [optional] |
855
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
856
+ | **content_type** | **String** | Content type header application/xml | [optional] |
857
+ | **body** | **String** | Job configuration in config.xml format | [optional] |
681
858
 
682
859
  ### Return type
683
860
 
@@ -689,21 +866,22 @@ nil (empty response body)
689
866
 
690
867
  ### HTTP request headers
691
868
 
692
- - **Content-Type**: Not defined
693
- - **Accept**: text/html
869
+ - **Content-Type**: application/json
870
+ - **Accept**: */*
694
871
 
695
872
 
873
+ ## post_create_view
696
874
 
697
- # **post_create_view**
698
875
  > post_create_view(name, opts)
699
876
 
700
877
 
701
878
 
702
879
  Create a new view using view configuration
703
880
 
704
- ### Example
881
+ ### Examples
882
+
705
883
  ```ruby
706
- # load the gem
884
+ require 'time'
707
885
  require 'swaggy_jenkins'
708
886
  # setup authorization
709
887
  SwaggyJenkinsClient.configure do |config|
@@ -713,30 +891,47 @@ SwaggyJenkinsClient.configure do |config|
713
891
  end
714
892
 
715
893
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
716
-
717
- name = "name_example" # String | Name of the new view
718
-
719
- opts = {
720
- body: "body_example", # String | View configuration in config.xml format
721
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
722
- content_type: "content_type_example" # String | Content type header application/xml
894
+ name = 'name_example' # String | Name of the new view
895
+ opts = {
896
+ jenkins_crumb: 'jenkins_crumb_example', # String | CSRF protection token
897
+ content_type: 'content_type_example', # String | Content type header application/xml
898
+ body: 'body_example' # String | View configuration in config.xml format
723
899
  }
724
900
 
725
901
  begin
902
+
726
903
  api_instance.post_create_view(name, opts)
727
904
  rescue SwaggyJenkinsClient::ApiError => e
728
- puts "Exception when calling RemoteAccessApi->post_create_view: #{e}"
905
+ puts "Error when calling RemoteAccessApi->post_create_view: #{e}"
906
+ end
907
+ ```
908
+
909
+ #### Using the post_create_view_with_http_info variant
910
+
911
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
912
+
913
+ > <Array(nil, Integer, Hash)> post_create_view_with_http_info(name, opts)
914
+
915
+ ```ruby
916
+ begin
917
+
918
+ data, status_code, headers = api_instance.post_create_view_with_http_info(name, opts)
919
+ p status_code # => 2xx
920
+ p headers # => { ... }
921
+ p data # => nil
922
+ rescue SwaggyJenkinsClient::ApiError => e
923
+ puts "Error when calling RemoteAccessApi->post_create_view_with_http_info: #{e}"
729
924
  end
730
925
  ```
731
926
 
732
927
  ### Parameters
733
928
 
734
- Name | Type | Description | Notes
735
- ------------- | ------------- | ------------- | -------------
736
- **name** | **String**| Name of the new view |
737
- **body** | **String**| View configuration in config.xml format | [optional]
738
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
739
- **content_type** | **String**| Content type header application/xml | [optional]
929
+ | Name | Type | Description | Notes |
930
+ | ---- | ---- | ----------- | ----- |
931
+ | **name** | **String** | Name of the new view | |
932
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
933
+ | **content_type** | **String** | Content type header application/xml | [optional] |
934
+ | **body** | **String** | View configuration in config.xml format | [optional] |
740
935
 
741
936
  ### Return type
742
937
 
@@ -748,21 +943,22 @@ nil (empty response body)
748
943
 
749
944
  ### HTTP request headers
750
945
 
751
- - **Content-Type**: Not defined
752
- - **Accept**: text/html
946
+ - **Content-Type**: application/json
947
+ - **Accept**: */*
753
948
 
754
949
 
950
+ ## post_job_build
755
951
 
756
- # **post_job_build**
757
952
  > post_job_build(name, json, opts)
758
953
 
759
954
 
760
955
 
761
956
  Build a job
762
957
 
763
- ### Example
958
+ ### Examples
959
+
764
960
  ```ruby
765
- # load the gem
961
+ require 'time'
766
962
  require 'swaggy_jenkins'
767
963
  # setup authorization
768
964
  SwaggyJenkinsClient.configure do |config|
@@ -772,31 +968,47 @@ SwaggyJenkinsClient.configure do |config|
772
968
  end
773
969
 
774
970
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
971
+ name = 'name_example' # String | Name of the job
972
+ json = 'json_example' # String |
973
+ opts = {
974
+ token: 'token_example', # String |
975
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
976
+ }
775
977
 
776
- name = "name_example" # String | Name of the job
978
+ begin
979
+
980
+ api_instance.post_job_build(name, json, opts)
981
+ rescue SwaggyJenkinsClient::ApiError => e
982
+ puts "Error when calling RemoteAccessApi->post_job_build: #{e}"
983
+ end
984
+ ```
777
985
 
778
- json = "json_example" # String |
986
+ #### Using the post_job_build_with_http_info variant
779
987
 
780
- opts = {
781
- token: "token_example", # String |
782
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
783
- }
988
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
989
+
990
+ > <Array(nil, Integer, Hash)> post_job_build_with_http_info(name, json, opts)
784
991
 
992
+ ```ruby
785
993
  begin
786
- api_instance.post_job_build(name, json, opts)
994
+
995
+ data, status_code, headers = api_instance.post_job_build_with_http_info(name, json, opts)
996
+ p status_code # => 2xx
997
+ p headers # => { ... }
998
+ p data # => nil
787
999
  rescue SwaggyJenkinsClient::ApiError => e
788
- puts "Exception when calling RemoteAccessApi->post_job_build: #{e}"
1000
+ puts "Error when calling RemoteAccessApi->post_job_build_with_http_info: #{e}"
789
1001
  end
790
1002
  ```
791
1003
 
792
1004
  ### Parameters
793
1005
 
794
- Name | Type | Description | Notes
795
- ------------- | ------------- | ------------- | -------------
796
- **name** | **String**| Name of the job |
797
- **json** | **String**| |
798
- **token** | **String**| | [optional]
799
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1006
+ | Name | Type | Description | Notes |
1007
+ | ---- | ---- | ----------- | ----- |
1008
+ | **name** | **String** | Name of the job | |
1009
+ | **json** | **String** | | |
1010
+ | **token** | **String** | | [optional] |
1011
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
800
1012
 
801
1013
  ### Return type
802
1014
 
@@ -808,21 +1020,22 @@ nil (empty response body)
808
1020
 
809
1021
  ### HTTP request headers
810
1022
 
811
- - **Content-Type**: Not defined
812
- - **Accept**: Not defined
1023
+ - **Content-Type**: Not defined
1024
+ - **Accept**: Not defined
813
1025
 
814
1026
 
1027
+ ## post_job_config
815
1028
 
816
- # **post_job_config**
817
1029
  > post_job_config(name, body, opts)
818
1030
 
819
1031
 
820
1032
 
821
1033
  Update job configuration
822
1034
 
823
- ### Example
1035
+ ### Examples
1036
+
824
1037
  ```ruby
825
- # load the gem
1038
+ require 'time'
826
1039
  require 'swaggy_jenkins'
827
1040
  # setup authorization
828
1041
  SwaggyJenkinsClient.configure do |config|
@@ -832,29 +1045,45 @@ SwaggyJenkinsClient.configure do |config|
832
1045
  end
833
1046
 
834
1047
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1048
+ name = 'name_example' # String | Name of the job
1049
+ body = 'body_example' # String | Job configuration in config.xml format
1050
+ opts = {
1051
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1052
+ }
1053
+
1054
+ begin
1055
+
1056
+ api_instance.post_job_config(name, body, opts)
1057
+ rescue SwaggyJenkinsClient::ApiError => e
1058
+ puts "Error when calling RemoteAccessApi->post_job_config: #{e}"
1059
+ end
1060
+ ```
835
1061
 
836
- name = "name_example" # String | Name of the job
1062
+ #### Using the post_job_config_with_http_info variant
837
1063
 
838
- body = "body_example" # String | Job configuration in config.xml format
1064
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
839
1065
 
840
- opts = {
841
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
842
- }
1066
+ > <Array(nil, Integer, Hash)> post_job_config_with_http_info(name, body, opts)
843
1067
 
1068
+ ```ruby
844
1069
  begin
845
- api_instance.post_job_config(name, body, opts)
1070
+
1071
+ data, status_code, headers = api_instance.post_job_config_with_http_info(name, body, opts)
1072
+ p status_code # => 2xx
1073
+ p headers # => { ... }
1074
+ p data # => nil
846
1075
  rescue SwaggyJenkinsClient::ApiError => e
847
- puts "Exception when calling RemoteAccessApi->post_job_config: #{e}"
1076
+ puts "Error when calling RemoteAccessApi->post_job_config_with_http_info: #{e}"
848
1077
  end
849
1078
  ```
850
1079
 
851
1080
  ### Parameters
852
1081
 
853
- Name | Type | Description | Notes
854
- ------------- | ------------- | ------------- | -------------
855
- **name** | **String**| Name of the job |
856
- **body** | **String**| Job configuration in config.xml format |
857
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1082
+ | Name | Type | Description | Notes |
1083
+ | ---- | ---- | ----------- | ----- |
1084
+ | **name** | **String** | Name of the job | |
1085
+ | **body** | **String** | Job configuration in config.xml format | |
1086
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
858
1087
 
859
1088
  ### Return type
860
1089
 
@@ -866,21 +1095,22 @@ nil (empty response body)
866
1095
 
867
1096
  ### HTTP request headers
868
1097
 
869
- - **Content-Type**: Not defined
870
- - **Accept**: text/xml
1098
+ - **Content-Type**: application/json
1099
+ - **Accept**: */*
871
1100
 
872
1101
 
1102
+ ## post_job_delete
873
1103
 
874
- # **post_job_delete**
875
- > post_job_delete(name, , opts)
1104
+ > post_job_delete(name, opts)
876
1105
 
877
1106
 
878
1107
 
879
1108
  Delete a job
880
1109
 
881
- ### Example
1110
+ ### Examples
1111
+
882
1112
  ```ruby
883
- # load the gem
1113
+ require 'time'
884
1114
  require 'swaggy_jenkins'
885
1115
  # setup authorization
886
1116
  SwaggyJenkinsClient.configure do |config|
@@ -890,26 +1120,43 @@ SwaggyJenkinsClient.configure do |config|
890
1120
  end
891
1121
 
892
1122
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1123
+ name = 'name_example' # String | Name of the job
1124
+ opts = {
1125
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1126
+ }
893
1127
 
894
- name = "name_example" # String | Name of the job
1128
+ begin
1129
+
1130
+ api_instance.post_job_delete(name, opts)
1131
+ rescue SwaggyJenkinsClient::ApiError => e
1132
+ puts "Error when calling RemoteAccessApi->post_job_delete: #{e}"
1133
+ end
1134
+ ```
895
1135
 
896
- opts = {
897
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
898
- }
1136
+ #### Using the post_job_delete_with_http_info variant
1137
+
1138
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1139
+
1140
+ > <Array(nil, Integer, Hash)> post_job_delete_with_http_info(name, opts)
899
1141
 
1142
+ ```ruby
900
1143
  begin
901
- api_instance.post_job_delete(name, , opts)
1144
+
1145
+ data, status_code, headers = api_instance.post_job_delete_with_http_info(name, opts)
1146
+ p status_code # => 2xx
1147
+ p headers # => { ... }
1148
+ p data # => nil
902
1149
  rescue SwaggyJenkinsClient::ApiError => e
903
- puts "Exception when calling RemoteAccessApi->post_job_delete: #{e}"
1150
+ puts "Error when calling RemoteAccessApi->post_job_delete_with_http_info: #{e}"
904
1151
  end
905
1152
  ```
906
1153
 
907
1154
  ### Parameters
908
1155
 
909
- Name | Type | Description | Notes
910
- ------------- | ------------- | ------------- | -------------
911
- **name** | **String**| Name of the job |
912
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1156
+ | Name | Type | Description | Notes |
1157
+ | ---- | ---- | ----------- | ----- |
1158
+ | **name** | **String** | Name of the job | |
1159
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
913
1160
 
914
1161
  ### Return type
915
1162
 
@@ -921,21 +1168,22 @@ nil (empty response body)
921
1168
 
922
1169
  ### HTTP request headers
923
1170
 
924
- - **Content-Type**: Not defined
925
- - **Accept**: Not defined
1171
+ - **Content-Type**: Not defined
1172
+ - **Accept**: Not defined
926
1173
 
927
1174
 
1175
+ ## post_job_disable
928
1176
 
929
- # **post_job_disable**
930
- > post_job_disable(name, , opts)
1177
+ > post_job_disable(name, opts)
931
1178
 
932
1179
 
933
1180
 
934
1181
  Disable a job
935
1182
 
936
- ### Example
1183
+ ### Examples
1184
+
937
1185
  ```ruby
938
- # load the gem
1186
+ require 'time'
939
1187
  require 'swaggy_jenkins'
940
1188
  # setup authorization
941
1189
  SwaggyJenkinsClient.configure do |config|
@@ -945,26 +1193,43 @@ SwaggyJenkinsClient.configure do |config|
945
1193
  end
946
1194
 
947
1195
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1196
+ name = 'name_example' # String | Name of the job
1197
+ opts = {
1198
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1199
+ }
948
1200
 
949
- name = "name_example" # String | Name of the job
1201
+ begin
1202
+
1203
+ api_instance.post_job_disable(name, opts)
1204
+ rescue SwaggyJenkinsClient::ApiError => e
1205
+ puts "Error when calling RemoteAccessApi->post_job_disable: #{e}"
1206
+ end
1207
+ ```
950
1208
 
951
- opts = {
952
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
953
- }
1209
+ #### Using the post_job_disable_with_http_info variant
954
1210
 
1211
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1212
+
1213
+ > <Array(nil, Integer, Hash)> post_job_disable_with_http_info(name, opts)
1214
+
1215
+ ```ruby
955
1216
  begin
956
- api_instance.post_job_disable(name, , opts)
1217
+
1218
+ data, status_code, headers = api_instance.post_job_disable_with_http_info(name, opts)
1219
+ p status_code # => 2xx
1220
+ p headers # => { ... }
1221
+ p data # => nil
957
1222
  rescue SwaggyJenkinsClient::ApiError => e
958
- puts "Exception when calling RemoteAccessApi->post_job_disable: #{e}"
1223
+ puts "Error when calling RemoteAccessApi->post_job_disable_with_http_info: #{e}"
959
1224
  end
960
1225
  ```
961
1226
 
962
1227
  ### Parameters
963
1228
 
964
- Name | Type | Description | Notes
965
- ------------- | ------------- | ------------- | -------------
966
- **name** | **String**| Name of the job |
967
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1229
+ | Name | Type | Description | Notes |
1230
+ | ---- | ---- | ----------- | ----- |
1231
+ | **name** | **String** | Name of the job | |
1232
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
968
1233
 
969
1234
  ### Return type
970
1235
 
@@ -976,21 +1241,22 @@ nil (empty response body)
976
1241
 
977
1242
  ### HTTP request headers
978
1243
 
979
- - **Content-Type**: Not defined
980
- - **Accept**: Not defined
1244
+ - **Content-Type**: Not defined
1245
+ - **Accept**: Not defined
981
1246
 
982
1247
 
1248
+ ## post_job_enable
983
1249
 
984
- # **post_job_enable**
985
- > post_job_enable(name, , opts)
1250
+ > post_job_enable(name, opts)
986
1251
 
987
1252
 
988
1253
 
989
1254
  Enable a job
990
1255
 
991
- ### Example
1256
+ ### Examples
1257
+
992
1258
  ```ruby
993
- # load the gem
1259
+ require 'time'
994
1260
  require 'swaggy_jenkins'
995
1261
  # setup authorization
996
1262
  SwaggyJenkinsClient.configure do |config|
@@ -1000,26 +1266,43 @@ SwaggyJenkinsClient.configure do |config|
1000
1266
  end
1001
1267
 
1002
1268
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1269
+ name = 'name_example' # String | Name of the job
1270
+ opts = {
1271
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1272
+ }
1003
1273
 
1004
- name = "name_example" # String | Name of the job
1274
+ begin
1275
+
1276
+ api_instance.post_job_enable(name, opts)
1277
+ rescue SwaggyJenkinsClient::ApiError => e
1278
+ puts "Error when calling RemoteAccessApi->post_job_enable: #{e}"
1279
+ end
1280
+ ```
1005
1281
 
1006
- opts = {
1007
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
1008
- }
1282
+ #### Using the post_job_enable_with_http_info variant
1283
+
1284
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1009
1285
 
1286
+ > <Array(nil, Integer, Hash)> post_job_enable_with_http_info(name, opts)
1287
+
1288
+ ```ruby
1010
1289
  begin
1011
- api_instance.post_job_enable(name, , opts)
1290
+
1291
+ data, status_code, headers = api_instance.post_job_enable_with_http_info(name, opts)
1292
+ p status_code # => 2xx
1293
+ p headers # => { ... }
1294
+ p data # => nil
1012
1295
  rescue SwaggyJenkinsClient::ApiError => e
1013
- puts "Exception when calling RemoteAccessApi->post_job_enable: #{e}"
1296
+ puts "Error when calling RemoteAccessApi->post_job_enable_with_http_info: #{e}"
1014
1297
  end
1015
1298
  ```
1016
1299
 
1017
1300
  ### Parameters
1018
1301
 
1019
- Name | Type | Description | Notes
1020
- ------------- | ------------- | ------------- | -------------
1021
- **name** | **String**| Name of the job |
1022
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1302
+ | Name | Type | Description | Notes |
1303
+ | ---- | ---- | ----------- | ----- |
1304
+ | **name** | **String** | Name of the job | |
1305
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
1023
1306
 
1024
1307
  ### Return type
1025
1308
 
@@ -1031,21 +1314,22 @@ nil (empty response body)
1031
1314
 
1032
1315
  ### HTTP request headers
1033
1316
 
1034
- - **Content-Type**: Not defined
1035
- - **Accept**: Not defined
1317
+ - **Content-Type**: Not defined
1318
+ - **Accept**: Not defined
1036
1319
 
1037
1320
 
1321
+ ## post_job_last_build_stop
1038
1322
 
1039
- # **post_job_last_build_stop**
1040
- > post_job_last_build_stop(name, , opts)
1323
+ > post_job_last_build_stop(name, opts)
1041
1324
 
1042
1325
 
1043
1326
 
1044
1327
  Stop a job
1045
1328
 
1046
- ### Example
1329
+ ### Examples
1330
+
1047
1331
  ```ruby
1048
- # load the gem
1332
+ require 'time'
1049
1333
  require 'swaggy_jenkins'
1050
1334
  # setup authorization
1051
1335
  SwaggyJenkinsClient.configure do |config|
@@ -1055,26 +1339,43 @@ SwaggyJenkinsClient.configure do |config|
1055
1339
  end
1056
1340
 
1057
1341
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1342
+ name = 'name_example' # String | Name of the job
1343
+ opts = {
1344
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1345
+ }
1058
1346
 
1059
- name = "name_example" # String | Name of the job
1347
+ begin
1348
+
1349
+ api_instance.post_job_last_build_stop(name, opts)
1350
+ rescue SwaggyJenkinsClient::ApiError => e
1351
+ puts "Error when calling RemoteAccessApi->post_job_last_build_stop: #{e}"
1352
+ end
1353
+ ```
1060
1354
 
1061
- opts = {
1062
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
1063
- }
1355
+ #### Using the post_job_last_build_stop_with_http_info variant
1356
+
1357
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1358
+
1359
+ > <Array(nil, Integer, Hash)> post_job_last_build_stop_with_http_info(name, opts)
1064
1360
 
1361
+ ```ruby
1065
1362
  begin
1066
- api_instance.post_job_last_build_stop(name, , opts)
1363
+
1364
+ data, status_code, headers = api_instance.post_job_last_build_stop_with_http_info(name, opts)
1365
+ p status_code # => 2xx
1366
+ p headers # => { ... }
1367
+ p data # => nil
1067
1368
  rescue SwaggyJenkinsClient::ApiError => e
1068
- puts "Exception when calling RemoteAccessApi->post_job_last_build_stop: #{e}"
1369
+ puts "Error when calling RemoteAccessApi->post_job_last_build_stop_with_http_info: #{e}"
1069
1370
  end
1070
1371
  ```
1071
1372
 
1072
1373
  ### Parameters
1073
1374
 
1074
- Name | Type | Description | Notes
1075
- ------------- | ------------- | ------------- | -------------
1076
- **name** | **String**| Name of the job |
1077
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1375
+ | Name | Type | Description | Notes |
1376
+ | ---- | ---- | ----------- | ----- |
1377
+ | **name** | **String** | Name of the job | |
1378
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
1078
1379
 
1079
1380
  ### Return type
1080
1381
 
@@ -1086,21 +1387,22 @@ nil (empty response body)
1086
1387
 
1087
1388
  ### HTTP request headers
1088
1389
 
1089
- - **Content-Type**: Not defined
1090
- - **Accept**: Not defined
1390
+ - **Content-Type**: Not defined
1391
+ - **Accept**: Not defined
1091
1392
 
1092
1393
 
1394
+ ## post_view_config
1093
1395
 
1094
- # **post_view_config**
1095
1396
  > post_view_config(name, body, opts)
1096
1397
 
1097
1398
 
1098
1399
 
1099
1400
  Update view configuration
1100
1401
 
1101
- ### Example
1402
+ ### Examples
1403
+
1102
1404
  ```ruby
1103
- # load the gem
1405
+ require 'time'
1104
1406
  require 'swaggy_jenkins'
1105
1407
  # setup authorization
1106
1408
  SwaggyJenkinsClient.configure do |config|
@@ -1110,29 +1412,45 @@ SwaggyJenkinsClient.configure do |config|
1110
1412
  end
1111
1413
 
1112
1414
  api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
1415
+ name = 'name_example' # String | Name of the view
1416
+ body = 'body_example' # String | View configuration in config.xml format
1417
+ opts = {
1418
+ jenkins_crumb: 'jenkins_crumb_example' # String | CSRF protection token
1419
+ }
1420
+
1421
+ begin
1422
+
1423
+ api_instance.post_view_config(name, body, opts)
1424
+ rescue SwaggyJenkinsClient::ApiError => e
1425
+ puts "Error when calling RemoteAccessApi->post_view_config: #{e}"
1426
+ end
1427
+ ```
1113
1428
 
1114
- name = "name_example" # String | Name of the view
1429
+ #### Using the post_view_config_with_http_info variant
1115
1430
 
1116
- body = "body_example" # String | View configuration in config.xml format
1431
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1117
1432
 
1118
- opts = {
1119
- jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
1120
- }
1433
+ > <Array(nil, Integer, Hash)> post_view_config_with_http_info(name, body, opts)
1121
1434
 
1435
+ ```ruby
1122
1436
  begin
1123
- api_instance.post_view_config(name, body, opts)
1437
+
1438
+ data, status_code, headers = api_instance.post_view_config_with_http_info(name, body, opts)
1439
+ p status_code # => 2xx
1440
+ p headers # => { ... }
1441
+ p data # => nil
1124
1442
  rescue SwaggyJenkinsClient::ApiError => e
1125
- puts "Exception when calling RemoteAccessApi->post_view_config: #{e}"
1443
+ puts "Error when calling RemoteAccessApi->post_view_config_with_http_info: #{e}"
1126
1444
  end
1127
1445
  ```
1128
1446
 
1129
1447
  ### Parameters
1130
1448
 
1131
- Name | Type | Description | Notes
1132
- ------------- | ------------- | ------------- | -------------
1133
- **name** | **String**| Name of the view |
1134
- **body** | **String**| View configuration in config.xml format |
1135
- **jenkins_crumb** | **String**| CSRF protection token | [optional]
1449
+ | Name | Type | Description | Notes |
1450
+ | ---- | ---- | ----------- | ----- |
1451
+ | **name** | **String** | Name of the view | |
1452
+ | **body** | **String** | View configuration in config.xml format | |
1453
+ | **jenkins_crumb** | **String** | CSRF protection token | [optional] |
1136
1454
 
1137
1455
  ### Return type
1138
1456
 
@@ -1144,8 +1462,6 @@ nil (empty response body)
1144
1462
 
1145
1463
  ### HTTP request headers
1146
1464
 
1147
- - **Content-Type**: Not defined
1148
- - **Accept**: Not defined
1149
-
1150
-
1465
+ - **Content-Type**: application/json
1466
+ - **Accept**: */*
1151
1467