swaggy_jenkins 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/README.md +249 -0
- data/Rakefile +8 -0
- data/docs/AllView.md +10 -0
- data/docs/BlueOceanApi.md +2034 -0
- data/docs/Body.md +8 -0
- data/docs/BranchImpl.md +20 -0
- data/docs/BranchImpllinks.md +12 -0
- data/docs/BranchImplpermissions.md +12 -0
- data/docs/CauseAction.md +9 -0
- data/docs/CauseUserIdCause.md +11 -0
- data/docs/ClassesByClass.md +9 -0
- data/docs/ClockDifference.md +9 -0
- data/docs/ComputerSet.md +12 -0
- data/docs/DefaultCrumbIssuer.md +10 -0
- data/docs/DiskSpaceMonitorDescriptorDiskSpace.md +11 -0
- data/docs/EmptyChangeLogSet.md +9 -0
- data/docs/ExtensionClassContainerImpl1.md +10 -0
- data/docs/ExtensionClassContainerImpl1links.md +9 -0
- data/docs/ExtensionClassContainerImpl1map.md +10 -0
- data/docs/ExtensionClassImpl.md +10 -0
- data/docs/ExtensionClassImpllinks.md +9 -0
- data/docs/FavoriteImpl.md +10 -0
- data/docs/FavoriteImpllinks.md +9 -0
- data/docs/FreeStyleBuild.md +25 -0
- data/docs/FreeStyleProject.md +34 -0
- data/docs/FreeStyleProjectactions.md +8 -0
- data/docs/FreeStyleProjecthealthReport.md +12 -0
- data/docs/GenericResource.md +13 -0
- data/docs/GithubContent.md +15 -0
- data/docs/GithubFile.md +9 -0
- data/docs/GithubOrganization.md +11 -0
- data/docs/GithubOrganizationlinks.md +10 -0
- data/docs/GithubRepositories.md +13 -0
- data/docs/GithubRepositorieslinks.md +9 -0
- data/docs/GithubRepository.md +15 -0
- data/docs/GithubRepositorylinks.md +9 -0
- data/docs/GithubRepositorypermissions.md +11 -0
- data/docs/GithubRespositoryContainer.md +10 -0
- data/docs/GithubRespositoryContainerlinks.md +9 -0
- data/docs/GithubScm.md +12 -0
- data/docs/GithubScmlinks.md +9 -0
- data/docs/Hudson.md +22 -0
- data/docs/HudsonMasterComputer.md +23 -0
- data/docs/HudsonMasterComputerexecutors.md +13 -0
- data/docs/HudsonMasterComputermonitorData.md +14 -0
- data/docs/HudsonassignedLabels.md +8 -0
- data/docs/InputStepImpl.md +14 -0
- data/docs/InputStepImpllinks.md +9 -0
- data/docs/Label1.md +8 -0
- data/docs/Link.md +9 -0
- data/docs/ListView.md +12 -0
- data/docs/MultibranchPipeline.md +21 -0
- data/docs/NullSCM.md +8 -0
- data/docs/Organisation.md +9 -0
- data/docs/Organisations.md +7 -0
- data/docs/Pipeline.md +15 -0
- data/docs/PipelineActivities.md +7 -0
- data/docs/PipelineActivity.md +22 -0
- data/docs/PipelineActivityartifacts.md +11 -0
- data/docs/PipelineBranches.md +7 -0
- data/docs/PipelineBranchesitem.md +16 -0
- data/docs/PipelineBranchesitemlatestRun.md +21 -0
- data/docs/PipelineBranchesitempullRequest.md +13 -0
- data/docs/PipelineBranchesitempullRequestlinks.md +9 -0
- data/docs/PipelineFolderImpl.md +14 -0
- data/docs/PipelineImpl.md +16 -0
- data/docs/PipelineImpllinks.md +12 -0
- data/docs/PipelineQueue.md +7 -0
- data/docs/PipelineRun.md +22 -0
- data/docs/PipelineRunImpl.md +22 -0
- data/docs/PipelineRunImpllinks.md +13 -0
- data/docs/PipelineRunNode.md +15 -0
- data/docs/PipelineRunNodeSteps.md +7 -0
- data/docs/PipelineRunNodeedges.md +9 -0
- data/docs/PipelineRunNodes.md +7 -0
- data/docs/PipelineRunSteps.md +7 -0
- data/docs/PipelineRunartifacts.md +11 -0
- data/docs/PipelineRuns.md +7 -0
- data/docs/PipelineStepImpl.md +16 -0
- data/docs/PipelineStepImpllinks.md +10 -0
- data/docs/PipelinelatestRun.md +22 -0
- data/docs/PipelinelatestRunartifacts.md +11 -0
- data/docs/Pipelines.md +7 -0
- data/docs/Queue.md +9 -0
- data/docs/QueueBlockedItem.md +19 -0
- data/docs/QueueItemImpl.md +12 -0
- data/docs/QueueLeftItem.md +20 -0
- data/docs/RemoteAccessApi.md +1151 -0
- data/docs/ResponseTimeMonitorData.md +10 -0
- data/docs/ScmOrganisations.md +7 -0
- data/docs/StringParameterDefinition.md +12 -0
- data/docs/StringParameterValue.md +10 -0
- data/docs/SwapSpaceMonitorMemoryUsage2.md +12 -0
- data/docs/UnlabeledLoadStatistics.md +8 -0
- data/docs/User.md +12 -0
- data/docs/UserFavorites.md +7 -0
- data/docs/Users.md +7 -0
- data/git_push.sh +55 -0
- data/lib/swaggy_jenkins.rb +134 -0
- data/lib/swaggy_jenkins/api/blue_ocean_api.rb +2200 -0
- data/lib/swaggy_jenkins/api/remote_access_api.rb +1166 -0
- data/lib/swaggy_jenkins/api_client.rb +389 -0
- data/lib/swaggy_jenkins/api_error.rb +38 -0
- data/lib/swaggy_jenkins/configuration.rb +209 -0
- data/lib/swaggy_jenkins/models/all_view.rb +206 -0
- data/lib/swaggy_jenkins/models/body.rb +193 -0
- data/lib/swaggy_jenkins/models/branch_impl.rb +298 -0
- data/lib/swaggy_jenkins/models/branch_impllinks.rb +224 -0
- data/lib/swaggy_jenkins/models/branch_implpermissions.rb +224 -0
- data/lib/swaggy_jenkins/models/cause_action.rb +199 -0
- data/lib/swaggy_jenkins/models/cause_user_id_cause.rb +215 -0
- data/lib/swaggy_jenkins/models/classes_by_class.rb +199 -0
- data/lib/swaggy_jenkins/models/clock_difference.rb +197 -0
- data/lib/swaggy_jenkins/models/computer_set.rb +226 -0
- data/lib/swaggy_jenkins/models/default_crumb_issuer.rb +206 -0
- data/lib/swaggy_jenkins/models/disk_space_monitor_descriptor_disk_space.rb +215 -0
- data/lib/swaggy_jenkins/models/empty_change_log_set.rb +197 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1.rb +206 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1links.rb +197 -0
- data/lib/swaggy_jenkins/models/extension_class_container_impl1map.rb +206 -0
- data/lib/swaggy_jenkins/models/extension_class_impl.rb +208 -0
- data/lib/swaggy_jenkins/models/extension_class_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/favorite_impl.rb +206 -0
- data/lib/swaggy_jenkins/models/favorite_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/free_style_build.rb +343 -0
- data/lib/swaggy_jenkins/models/free_style_project.rb +428 -0
- data/lib/swaggy_jenkins/models/free_style_projectactions.rb +188 -0
- data/lib/swaggy_jenkins/models/free_style_projecthealth_report.rb +224 -0
- data/lib/swaggy_jenkins/models/generic_resource.rb +233 -0
- data/lib/swaggy_jenkins/models/github_content.rb +251 -0
- data/lib/swaggy_jenkins/models/github_file.rb +197 -0
- data/lib/swaggy_jenkins/models/github_organization.rb +215 -0
- data/lib/swaggy_jenkins/models/github_organizationlinks.rb +206 -0
- data/lib/swaggy_jenkins/models/github_repositories.rb +235 -0
- data/lib/swaggy_jenkins/models/github_repositorieslinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_repository.rb +251 -0
- data/lib/swaggy_jenkins/models/github_repositorylinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_repositorypermissions.rb +215 -0
- data/lib/swaggy_jenkins/models/github_respository_container.rb +206 -0
- data/lib/swaggy_jenkins/models/github_respository_containerlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/github_scm.rb +224 -0
- data/lib/swaggy_jenkins/models/github_scmlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/hudson.rb +320 -0
- data/lib/swaggy_jenkins/models/hudson_master_computer.rb +325 -0
- data/lib/swaggy_jenkins/models/hudson_master_computerexecutors.rb +233 -0
- data/lib/swaggy_jenkins/models/hudson_master_computermonitor_data.rb +242 -0
- data/lib/swaggy_jenkins/models/hudsonassigned_labels.rb +188 -0
- data/lib/swaggy_jenkins/models/input_step_impl.rb +244 -0
- data/lib/swaggy_jenkins/models/input_step_impllinks.rb +197 -0
- data/lib/swaggy_jenkins/models/label1.rb +188 -0
- data/lib/swaggy_jenkins/models/link.rb +197 -0
- data/lib/swaggy_jenkins/models/list_view.rb +226 -0
- data/lib/swaggy_jenkins/models/multibranch_pipeline.rb +307 -0
- data/lib/swaggy_jenkins/models/null_scm.rb +188 -0
- data/lib/swaggy_jenkins/models/organisation.rb +197 -0
- data/lib/swaggy_jenkins/models/organisations.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline.rb +251 -0
- data/lib/swaggy_jenkins/models/pipeline_activities.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_activity.rb +316 -0
- data/lib/swaggy_jenkins/models/pipeline_activityartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipeline_branches.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitem.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitemlatest_run.rb +305 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitempull_request.rb +233 -0
- data/lib/swaggy_jenkins/models/pipeline_branchesitempull_requestlinks.rb +197 -0
- data/lib/swaggy_jenkins/models/pipeline_folder_impl.rb +242 -0
- data/lib/swaggy_jenkins/models/pipeline_impl.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_impllinks.rb +224 -0
- data/lib/swaggy_jenkins/models/pipeline_queue.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run.rb +316 -0
- data/lib/swaggy_jenkins/models/pipeline_run_impl.rb +314 -0
- data/lib/swaggy_jenkins/models/pipeline_run_impllinks.rb +233 -0
- data/lib/swaggy_jenkins/models/pipeline_run_node.rb +253 -0
- data/lib/swaggy_jenkins/models/pipeline_run_node_steps.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run_nodeedges.rb +197 -0
- data/lib/swaggy_jenkins/models/pipeline_run_nodes.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_run_steps.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_runartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipeline_runs.rb +179 -0
- data/lib/swaggy_jenkins/models/pipeline_step_impl.rb +260 -0
- data/lib/swaggy_jenkins/models/pipeline_step_impllinks.rb +206 -0
- data/lib/swaggy_jenkins/models/pipelinelatest_run.rb +316 -0
- data/lib/swaggy_jenkins/models/pipelinelatest_runartifacts.rb +215 -0
- data/lib/swaggy_jenkins/models/pipelines.rb +179 -0
- data/lib/swaggy_jenkins/models/queue.rb +199 -0
- data/lib/swaggy_jenkins/models/queue_blocked_item.rb +289 -0
- data/lib/swaggy_jenkins/models/queue_item_impl.rb +224 -0
- data/lib/swaggy_jenkins/models/queue_left_item.rb +298 -0
- data/lib/swaggy_jenkins/models/response_time_monitor_data.rb +206 -0
- data/lib/swaggy_jenkins/models/scm_organisations.rb +179 -0
- data/lib/swaggy_jenkins/models/string_parameter_definition.rb +224 -0
- data/lib/swaggy_jenkins/models/string_parameter_value.rb +206 -0
- data/lib/swaggy_jenkins/models/swap_space_monitor_memory_usage2.rb +224 -0
- data/lib/swaggy_jenkins/models/unlabeled_load_statistics.rb +188 -0
- data/lib/swaggy_jenkins/models/user.rb +224 -0
- data/lib/swaggy_jenkins/models/user_favorites.rb +179 -0
- data/lib/swaggy_jenkins/models/users.rb +179 -0
- data/lib/swaggy_jenkins/version.rb +15 -0
- data/spec/api/blue_ocean_api_spec.rb +513 -0
- data/spec/api/remote_access_api_spec.rb +304 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/all_view_spec.rb +54 -0
- data/spec/models/body_spec.rb +42 -0
- data/spec/models/branch_impl_spec.rb +114 -0
- data/spec/models/branch_impllinks_spec.rb +66 -0
- data/spec/models/branch_implpermissions_spec.rb +66 -0
- data/spec/models/cause_action_spec.rb +48 -0
- data/spec/models/cause_user_id_cause_spec.rb +60 -0
- data/spec/models/classes_by_class_spec.rb +48 -0
- data/spec/models/clock_difference_spec.rb +48 -0
- data/spec/models/computer_set_spec.rb +66 -0
- data/spec/models/default_crumb_issuer_spec.rb +54 -0
- data/spec/models/disk_space_monitor_descriptor_disk_space_spec.rb +60 -0
- data/spec/models/empty_change_log_set_spec.rb +48 -0
- data/spec/models/extension_class_container_impl1_spec.rb +54 -0
- data/spec/models/extension_class_container_impl1links_spec.rb +48 -0
- data/spec/models/extension_class_container_impl1map_spec.rb +54 -0
- data/spec/models/extension_class_impl_spec.rb +54 -0
- data/spec/models/extension_class_impllinks_spec.rb +48 -0
- data/spec/models/favorite_impl_spec.rb +54 -0
- data/spec/models/favorite_impllinks_spec.rb +48 -0
- data/spec/models/free_style_build_spec.rb +144 -0
- data/spec/models/free_style_project_spec.rb +198 -0
- data/spec/models/free_style_projectactions_spec.rb +42 -0
- data/spec/models/free_style_projecthealth_report_spec.rb +66 -0
- data/spec/models/generic_resource_spec.rb +72 -0
- data/spec/models/github_content_spec.rb +84 -0
- data/spec/models/github_file_spec.rb +48 -0
- data/spec/models/github_organization_spec.rb +60 -0
- data/spec/models/github_organizationlinks_spec.rb +54 -0
- data/spec/models/github_repositories_spec.rb +72 -0
- data/spec/models/github_repositorieslinks_spec.rb +48 -0
- data/spec/models/github_repository_spec.rb +84 -0
- data/spec/models/github_repositorylinks_spec.rb +48 -0
- data/spec/models/github_repositorypermissions_spec.rb +60 -0
- data/spec/models/github_respository_container_spec.rb +54 -0
- data/spec/models/github_respository_containerlinks_spec.rb +48 -0
- data/spec/models/github_scm_spec.rb +66 -0
- data/spec/models/github_scmlinks_spec.rb +48 -0
- data/spec/models/hudson_master_computer_spec.rb +132 -0
- data/spec/models/hudson_master_computerexecutors_spec.rb +72 -0
- data/spec/models/hudson_master_computermonitor_data_spec.rb +78 -0
- data/spec/models/hudson_spec.rb +126 -0
- data/spec/models/hudsonassigned_labels_spec.rb +42 -0
- data/spec/models/input_step_impl_spec.rb +78 -0
- data/spec/models/input_step_impllinks_spec.rb +48 -0
- data/spec/models/label1_spec.rb +42 -0
- data/spec/models/link_spec.rb +48 -0
- data/spec/models/list_view_spec.rb +66 -0
- data/spec/models/multibranch_pipeline_spec.rb +120 -0
- data/spec/models/null_scm_spec.rb +42 -0
- data/spec/models/organisation_spec.rb +48 -0
- data/spec/models/organisations_spec.rb +36 -0
- data/spec/models/pipeline_activities_spec.rb +36 -0
- data/spec/models/pipeline_activity_spec.rb +126 -0
- data/spec/models/pipeline_activityartifacts_spec.rb +60 -0
- data/spec/models/pipeline_branches_spec.rb +36 -0
- data/spec/models/pipeline_branchesitem_spec.rb +90 -0
- data/spec/models/pipeline_branchesitemlatest_run_spec.rb +120 -0
- data/spec/models/pipeline_branchesitempull_request_spec.rb +72 -0
- data/spec/models/pipeline_branchesitempull_requestlinks_spec.rb +48 -0
- data/spec/models/pipeline_folder_impl_spec.rb +78 -0
- data/spec/models/pipeline_impl_spec.rb +90 -0
- data/spec/models/pipeline_impllinks_spec.rb +66 -0
- data/spec/models/pipeline_queue_spec.rb +36 -0
- data/spec/models/pipeline_run_impl_spec.rb +126 -0
- data/spec/models/pipeline_run_impllinks_spec.rb +72 -0
- data/spec/models/pipeline_run_node_spec.rb +84 -0
- data/spec/models/pipeline_run_node_steps_spec.rb +36 -0
- data/spec/models/pipeline_run_nodeedges_spec.rb +48 -0
- data/spec/models/pipeline_run_nodes_spec.rb +36 -0
- data/spec/models/pipeline_run_spec.rb +126 -0
- data/spec/models/pipeline_run_steps_spec.rb +36 -0
- data/spec/models/pipeline_runartifacts_spec.rb +60 -0
- data/spec/models/pipeline_runs_spec.rb +36 -0
- data/spec/models/pipeline_spec.rb +84 -0
- data/spec/models/pipeline_step_impl_spec.rb +90 -0
- data/spec/models/pipeline_step_impllinks_spec.rb +54 -0
- data/spec/models/pipelinelatest_run_spec.rb +126 -0
- data/spec/models/pipelinelatest_runartifacts_spec.rb +60 -0
- data/spec/models/pipelines_spec.rb +36 -0
- data/spec/models/queue_blocked_item_spec.rb +108 -0
- data/spec/models/queue_item_impl_spec.rb +66 -0
- data/spec/models/queue_left_item_spec.rb +114 -0
- data/spec/models/queue_spec.rb +48 -0
- data/spec/models/response_time_monitor_data_spec.rb +54 -0
- data/spec/models/scm_organisations_spec.rb +36 -0
- data/spec/models/string_parameter_definition_spec.rb +66 -0
- data/spec/models/string_parameter_value_spec.rb +54 -0
- data/spec/models/swap_space_monitor_memory_usage2_spec.rb +66 -0
- data/spec/models/unlabeled_load_statistics_spec.rb +42 -0
- data/spec/models/user_favorites_spec.rb +36 -0
- data/spec/models/user_spec.rb +66 -0
- data/spec/models/users_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/swaggy_jenkins.gemspec +45 -0
- metadata +621 -0
@@ -0,0 +1,22 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineRunImpl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**_links** | [**PipelineRunImpllinks**](PipelineRunImpllinks.md) | | [optional]
|
8
|
+
**duration_in_millis** | **Integer** | | [optional]
|
9
|
+
**en_queue_time** | **String** | | [optional]
|
10
|
+
**end_time** | **String** | | [optional]
|
11
|
+
**estimated_duration_in_millis** | **Integer** | | [optional]
|
12
|
+
**id** | **String** | | [optional]
|
13
|
+
**organization** | **String** | | [optional]
|
14
|
+
**pipeline** | **String** | | [optional]
|
15
|
+
**result** | **String** | | [optional]
|
16
|
+
**run_summary** | **String** | | [optional]
|
17
|
+
**start_time** | **String** | | [optional]
|
18
|
+
**state** | **String** | | [optional]
|
19
|
+
**type** | **String** | | [optional]
|
20
|
+
**commit_id** | **String** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineRunImpllinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**nodes** | [**Link**](Link.md) | | [optional]
|
7
|
+
**log** | [**Link**](Link.md) | | [optional]
|
8
|
+
**_self** | [**Link**](Link.md) | | [optional]
|
9
|
+
**actions** | [**Link**](Link.md) | | [optional]
|
10
|
+
**steps** | [**Link**](Link.md) | | [optional]
|
11
|
+
**_class** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineRunNode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**display_name** | **String** | | [optional]
|
8
|
+
**duration_in_millis** | **Integer** | | [optional]
|
9
|
+
**edges** | [**Array<PipelineRunNodeedges>**](PipelineRunNodeedges.md) | | [optional]
|
10
|
+
**id** | **String** | | [optional]
|
11
|
+
**result** | **String** | | [optional]
|
12
|
+
**start_time** | **String** | | [optional]
|
13
|
+
**state** | **String** | | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineRunartifacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**size** | **Integer** | | [optional]
|
8
|
+
**url** | **String** | | [optional]
|
9
|
+
**_class** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineStepImpl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**_links** | [**PipelineStepImpllinks**](PipelineStepImpllinks.md) | | [optional]
|
8
|
+
**display_name** | **String** | | [optional]
|
9
|
+
**duration_in_millis** | **Integer** | | [optional]
|
10
|
+
**id** | **String** | | [optional]
|
11
|
+
**input** | [**InputStepImpl**](InputStepImpl.md) | | [optional]
|
12
|
+
**result** | **String** | | [optional]
|
13
|
+
**start_time** | **String** | | [optional]
|
14
|
+
**state** | **String** | | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelineStepImpllinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_self** | [**Link**](Link.md) | | [optional]
|
7
|
+
**actions** | [**Link**](Link.md) | | [optional]
|
8
|
+
**_class** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelinelatestRun
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**artifacts** | [**Array<PipelinelatestRunartifacts>**](PipelinelatestRunartifacts.md) | | [optional]
|
7
|
+
**duration_in_millis** | **Integer** | | [optional]
|
8
|
+
**estimated_duration_in_millis** | **Integer** | | [optional]
|
9
|
+
**en_queue_time** | **String** | | [optional]
|
10
|
+
**end_time** | **String** | | [optional]
|
11
|
+
**id** | **String** | | [optional]
|
12
|
+
**organization** | **String** | | [optional]
|
13
|
+
**pipeline** | **String** | | [optional]
|
14
|
+
**result** | **String** | | [optional]
|
15
|
+
**run_summary** | **String** | | [optional]
|
16
|
+
**start_time** | **String** | | [optional]
|
17
|
+
**state** | **String** | | [optional]
|
18
|
+
**type** | **String** | | [optional]
|
19
|
+
**commit_id** | **String** | | [optional]
|
20
|
+
**_class** | **String** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggyJenkinsClient::PipelinelatestRunartifacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**size** | **Integer** | | [optional]
|
8
|
+
**url** | **String** | | [optional]
|
9
|
+
**_class** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Pipelines.md
ADDED
data/docs/Queue.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggyJenkinsClient::Queue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**items** | [**Array<QueueBlockedItem>**](QueueBlockedItem.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# SwaggyJenkinsClient::QueueBlockedItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**actions** | [**Array<CauseAction>**](CauseAction.md) | | [optional]
|
8
|
+
**blocked** | **BOOLEAN** | | [optional]
|
9
|
+
**buildable** | **BOOLEAN** | | [optional]
|
10
|
+
**id** | **Integer** | | [optional]
|
11
|
+
**in_queue_since** | **Integer** | | [optional]
|
12
|
+
**params** | **String** | | [optional]
|
13
|
+
**stuck** | **BOOLEAN** | | [optional]
|
14
|
+
**task** | [**FreeStyleProject**](FreeStyleProject.md) | | [optional]
|
15
|
+
**url** | **String** | | [optional]
|
16
|
+
**why** | **String** | | [optional]
|
17
|
+
**buildable_start_milliseconds** | **Integer** | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# SwaggyJenkinsClient::QueueItemImpl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**expected_build_number** | **Integer** | | [optional]
|
8
|
+
**id** | **String** | | [optional]
|
9
|
+
**pipeline** | **String** | | [optional]
|
10
|
+
**queued_time** | **Integer** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SwaggyJenkinsClient::QueueLeftItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_class** | **String** | | [optional]
|
7
|
+
**actions** | [**Array<CauseAction>**](CauseAction.md) | | [optional]
|
8
|
+
**blocked** | **BOOLEAN** | | [optional]
|
9
|
+
**buildable** | **BOOLEAN** | | [optional]
|
10
|
+
**id** | **Integer** | | [optional]
|
11
|
+
**in_queue_since** | **Integer** | | [optional]
|
12
|
+
**params** | **String** | | [optional]
|
13
|
+
**stuck** | **BOOLEAN** | | [optional]
|
14
|
+
**task** | [**FreeStyleProject**](FreeStyleProject.md) | | [optional]
|
15
|
+
**url** | **String** | | [optional]
|
16
|
+
**why** | **String** | | [optional]
|
17
|
+
**cancelled** | **BOOLEAN** | | [optional]
|
18
|
+
**executable** | [**FreeStyleBuild**](FreeStyleBuild.md) | | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,1151 @@
|
|
1
|
+
# SwaggyJenkinsClient::RemoteAccessApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
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)
|
32
|
+
|
33
|
+
|
34
|
+
|
35
|
+
Retrieve computer details
|
36
|
+
|
37
|
+
### Example
|
38
|
+
```ruby
|
39
|
+
# load the gem
|
40
|
+
require 'swaggy_jenkins'
|
41
|
+
# setup authorization
|
42
|
+
SwaggyJenkinsClient.configure do |config|
|
43
|
+
# Configure HTTP basic authorization: jenkins_auth
|
44
|
+
config.username = 'YOUR USERNAME'
|
45
|
+
config.password = 'YOUR PASSWORD'
|
46
|
+
end
|
47
|
+
|
48
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
49
|
+
|
50
|
+
depth = 56 # Integer | Recursion depth in response model
|
51
|
+
|
52
|
+
|
53
|
+
begin
|
54
|
+
result = api_instance.get_computer(depth)
|
55
|
+
p result
|
56
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
57
|
+
puts "Exception when calling RemoteAccessApi->get_computer: #{e}"
|
58
|
+
end
|
59
|
+
```
|
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
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
Retrieve CSRF protection token
|
88
|
+
|
89
|
+
### Example
|
90
|
+
```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
|
+
begin
|
103
|
+
result = api_instance.get_crumb
|
104
|
+
p result
|
105
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
106
|
+
puts "Exception when calling RemoteAccessApi->get_crumb: #{e}"
|
107
|
+
end
|
108
|
+
```
|
109
|
+
|
110
|
+
### Parameters
|
111
|
+
This endpoint does not need any parameter.
|
112
|
+
|
113
|
+
### Return type
|
114
|
+
|
115
|
+
[**DefaultCrumbIssuer**](DefaultCrumbIssuer.md)
|
116
|
+
|
117
|
+
### Authorization
|
118
|
+
|
119
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
120
|
+
|
121
|
+
### HTTP request headers
|
122
|
+
|
123
|
+
- **Content-Type**: Not defined
|
124
|
+
- **Accept**: application/json
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
# **get_jenkins**
|
129
|
+
> Hudson get_jenkins
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
Retrieve Jenkins details
|
134
|
+
|
135
|
+
### Example
|
136
|
+
```ruby
|
137
|
+
# load the gem
|
138
|
+
require 'swaggy_jenkins'
|
139
|
+
# setup authorization
|
140
|
+
SwaggyJenkinsClient.configure do |config|
|
141
|
+
# Configure HTTP basic authorization: jenkins_auth
|
142
|
+
config.username = 'YOUR USERNAME'
|
143
|
+
config.password = 'YOUR PASSWORD'
|
144
|
+
end
|
145
|
+
|
146
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
147
|
+
|
148
|
+
begin
|
149
|
+
result = api_instance.get_jenkins
|
150
|
+
p result
|
151
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
152
|
+
puts "Exception when calling RemoteAccessApi->get_jenkins: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
This endpoint does not need any parameter.
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
[**Hudson**](Hudson.md)
|
162
|
+
|
163
|
+
### Authorization
|
164
|
+
|
165
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
166
|
+
|
167
|
+
### HTTP request headers
|
168
|
+
|
169
|
+
- **Content-Type**: Not defined
|
170
|
+
- **Accept**: application/json
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
# **get_job**
|
175
|
+
> FreeStyleProject get_job(name, )
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
Retrieve job details
|
180
|
+
|
181
|
+
### Example
|
182
|
+
```ruby
|
183
|
+
# load the gem
|
184
|
+
require 'swaggy_jenkins'
|
185
|
+
# setup authorization
|
186
|
+
SwaggyJenkinsClient.configure do |config|
|
187
|
+
# Configure HTTP basic authorization: jenkins_auth
|
188
|
+
config.username = 'YOUR USERNAME'
|
189
|
+
config.password = 'YOUR PASSWORD'
|
190
|
+
end
|
191
|
+
|
192
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
193
|
+
|
194
|
+
name = "name_example" # String | Name of the job
|
195
|
+
|
196
|
+
|
197
|
+
begin
|
198
|
+
result = api_instance.get_job(name, )
|
199
|
+
p result
|
200
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
201
|
+
puts "Exception when calling RemoteAccessApi->get_job: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
### Parameters
|
206
|
+
|
207
|
+
Name | Type | Description | Notes
|
208
|
+
------------- | ------------- | ------------- | -------------
|
209
|
+
**name** | **String**| Name of the job |
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
[**FreeStyleProject**](FreeStyleProject.md)
|
214
|
+
|
215
|
+
### Authorization
|
216
|
+
|
217
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
218
|
+
|
219
|
+
### HTTP request headers
|
220
|
+
|
221
|
+
- **Content-Type**: Not defined
|
222
|
+
- **Accept**: application/json
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
# **get_job_config**
|
227
|
+
> String get_job_config(name, )
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
Retrieve job configuration
|
232
|
+
|
233
|
+
### Example
|
234
|
+
```ruby
|
235
|
+
# load the gem
|
236
|
+
require 'swaggy_jenkins'
|
237
|
+
# setup authorization
|
238
|
+
SwaggyJenkinsClient.configure do |config|
|
239
|
+
# Configure HTTP basic authorization: jenkins_auth
|
240
|
+
config.username = 'YOUR USERNAME'
|
241
|
+
config.password = 'YOUR PASSWORD'
|
242
|
+
end
|
243
|
+
|
244
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
245
|
+
|
246
|
+
name = "name_example" # String | Name of the job
|
247
|
+
|
248
|
+
|
249
|
+
begin
|
250
|
+
result = api_instance.get_job_config(name, )
|
251
|
+
p result
|
252
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
253
|
+
puts "Exception when calling RemoteAccessApi->get_job_config: #{e}"
|
254
|
+
end
|
255
|
+
```
|
256
|
+
|
257
|
+
### Parameters
|
258
|
+
|
259
|
+
Name | Type | Description | Notes
|
260
|
+
------------- | ------------- | ------------- | -------------
|
261
|
+
**name** | **String**| Name of the job |
|
262
|
+
|
263
|
+
### Return type
|
264
|
+
|
265
|
+
**String**
|
266
|
+
|
267
|
+
### Authorization
|
268
|
+
|
269
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
270
|
+
|
271
|
+
### HTTP request headers
|
272
|
+
|
273
|
+
- **Content-Type**: Not defined
|
274
|
+
- **Accept**: text/xml
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
# **get_job_last_build**
|
279
|
+
> FreeStyleBuild get_job_last_build(name, )
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
Retrieve job's last build details
|
284
|
+
|
285
|
+
### Example
|
286
|
+
```ruby
|
287
|
+
# load the gem
|
288
|
+
require 'swaggy_jenkins'
|
289
|
+
# setup authorization
|
290
|
+
SwaggyJenkinsClient.configure do |config|
|
291
|
+
# Configure HTTP basic authorization: jenkins_auth
|
292
|
+
config.username = 'YOUR USERNAME'
|
293
|
+
config.password = 'YOUR PASSWORD'
|
294
|
+
end
|
295
|
+
|
296
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
297
|
+
|
298
|
+
name = "name_example" # String | Name of the job
|
299
|
+
|
300
|
+
|
301
|
+
begin
|
302
|
+
result = api_instance.get_job_last_build(name, )
|
303
|
+
p result
|
304
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
305
|
+
puts "Exception when calling RemoteAccessApi->get_job_last_build: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
### Parameters
|
310
|
+
|
311
|
+
Name | Type | Description | Notes
|
312
|
+
------------- | ------------- | ------------- | -------------
|
313
|
+
**name** | **String**| Name of the job |
|
314
|
+
|
315
|
+
### Return type
|
316
|
+
|
317
|
+
[**FreeStyleBuild**](FreeStyleBuild.md)
|
318
|
+
|
319
|
+
### Authorization
|
320
|
+
|
321
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
322
|
+
|
323
|
+
### HTTP request headers
|
324
|
+
|
325
|
+
- **Content-Type**: Not defined
|
326
|
+
- **Accept**: application/json
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
# **get_job_progressive_text**
|
331
|
+
> get_job_progressive_text(name, number, start)
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
Retrieve job's build progressive text output
|
336
|
+
|
337
|
+
### Example
|
338
|
+
```ruby
|
339
|
+
# load the gem
|
340
|
+
require 'swaggy_jenkins'
|
341
|
+
# setup authorization
|
342
|
+
SwaggyJenkinsClient.configure do |config|
|
343
|
+
# Configure HTTP basic authorization: jenkins_auth
|
344
|
+
config.username = 'YOUR USERNAME'
|
345
|
+
config.password = 'YOUR PASSWORD'
|
346
|
+
end
|
347
|
+
|
348
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
349
|
+
|
350
|
+
name = "name_example" # String | Name of the job
|
351
|
+
|
352
|
+
number = "number_example" # String | Build number
|
353
|
+
|
354
|
+
start = "start_example" # String | Starting point of progressive text output
|
355
|
+
|
356
|
+
|
357
|
+
begin
|
358
|
+
api_instance.get_job_progressive_text(name, number, start)
|
359
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
360
|
+
puts "Exception when calling RemoteAccessApi->get_job_progressive_text: #{e}"
|
361
|
+
end
|
362
|
+
```
|
363
|
+
|
364
|
+
### Parameters
|
365
|
+
|
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 |
|
371
|
+
|
372
|
+
### Return type
|
373
|
+
|
374
|
+
nil (empty response body)
|
375
|
+
|
376
|
+
### Authorization
|
377
|
+
|
378
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
379
|
+
|
380
|
+
### HTTP request headers
|
381
|
+
|
382
|
+
- **Content-Type**: Not defined
|
383
|
+
- **Accept**: Not defined
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
# **get_queue**
|
388
|
+
> Queue get_queue
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
Retrieve queue details
|
393
|
+
|
394
|
+
### Example
|
395
|
+
```ruby
|
396
|
+
# load the gem
|
397
|
+
require 'swaggy_jenkins'
|
398
|
+
# setup authorization
|
399
|
+
SwaggyJenkinsClient.configure do |config|
|
400
|
+
# Configure HTTP basic authorization: jenkins_auth
|
401
|
+
config.username = 'YOUR USERNAME'
|
402
|
+
config.password = 'YOUR PASSWORD'
|
403
|
+
end
|
404
|
+
|
405
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
406
|
+
|
407
|
+
begin
|
408
|
+
result = api_instance.get_queue
|
409
|
+
p result
|
410
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
411
|
+
puts "Exception when calling RemoteAccessApi->get_queue: #{e}"
|
412
|
+
end
|
413
|
+
```
|
414
|
+
|
415
|
+
### Parameters
|
416
|
+
This endpoint does not need any parameter.
|
417
|
+
|
418
|
+
### Return type
|
419
|
+
|
420
|
+
[**Queue**](Queue.md)
|
421
|
+
|
422
|
+
### Authorization
|
423
|
+
|
424
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
425
|
+
|
426
|
+
### HTTP request headers
|
427
|
+
|
428
|
+
- **Content-Type**: Not defined
|
429
|
+
- **Accept**: application/json
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
# **get_queue_item**
|
434
|
+
> Queue get_queue_item(number)
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
Retrieve queued item details
|
439
|
+
|
440
|
+
### Example
|
441
|
+
```ruby
|
442
|
+
# load the gem
|
443
|
+
require 'swaggy_jenkins'
|
444
|
+
# setup authorization
|
445
|
+
SwaggyJenkinsClient.configure do |config|
|
446
|
+
# Configure HTTP basic authorization: jenkins_auth
|
447
|
+
config.username = 'YOUR USERNAME'
|
448
|
+
config.password = 'YOUR PASSWORD'
|
449
|
+
end
|
450
|
+
|
451
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
452
|
+
|
453
|
+
number = "number_example" # String | Queue number
|
454
|
+
|
455
|
+
|
456
|
+
begin
|
457
|
+
result = api_instance.get_queue_item(number)
|
458
|
+
p result
|
459
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
460
|
+
puts "Exception when calling RemoteAccessApi->get_queue_item: #{e}"
|
461
|
+
end
|
462
|
+
```
|
463
|
+
|
464
|
+
### Parameters
|
465
|
+
|
466
|
+
Name | Type | Description | Notes
|
467
|
+
------------- | ------------- | ------------- | -------------
|
468
|
+
**number** | **String**| Queue number |
|
469
|
+
|
470
|
+
### Return type
|
471
|
+
|
472
|
+
[**Queue**](Queue.md)
|
473
|
+
|
474
|
+
### Authorization
|
475
|
+
|
476
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
477
|
+
|
478
|
+
### HTTP request headers
|
479
|
+
|
480
|
+
- **Content-Type**: Not defined
|
481
|
+
- **Accept**: application/json
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
# **get_view**
|
486
|
+
> ListView get_view(name, )
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
Retrieve view details
|
491
|
+
|
492
|
+
### Example
|
493
|
+
```ruby
|
494
|
+
# load the gem
|
495
|
+
require 'swaggy_jenkins'
|
496
|
+
# setup authorization
|
497
|
+
SwaggyJenkinsClient.configure do |config|
|
498
|
+
# Configure HTTP basic authorization: jenkins_auth
|
499
|
+
config.username = 'YOUR USERNAME'
|
500
|
+
config.password = 'YOUR PASSWORD'
|
501
|
+
end
|
502
|
+
|
503
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
504
|
+
|
505
|
+
name = "name_example" # String | Name of the view
|
506
|
+
|
507
|
+
|
508
|
+
begin
|
509
|
+
result = api_instance.get_view(name, )
|
510
|
+
p result
|
511
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
512
|
+
puts "Exception when calling RemoteAccessApi->get_view: #{e}"
|
513
|
+
end
|
514
|
+
```
|
515
|
+
|
516
|
+
### Parameters
|
517
|
+
|
518
|
+
Name | Type | Description | Notes
|
519
|
+
------------- | ------------- | ------------- | -------------
|
520
|
+
**name** | **String**| Name of the view |
|
521
|
+
|
522
|
+
### Return type
|
523
|
+
|
524
|
+
[**ListView**](ListView.md)
|
525
|
+
|
526
|
+
### Authorization
|
527
|
+
|
528
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
529
|
+
|
530
|
+
### HTTP request headers
|
531
|
+
|
532
|
+
- **Content-Type**: Not defined
|
533
|
+
- **Accept**: application/json
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
# **get_view_config**
|
538
|
+
> String get_view_config(name, )
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
Retrieve view configuration
|
543
|
+
|
544
|
+
### Example
|
545
|
+
```ruby
|
546
|
+
# load the gem
|
547
|
+
require 'swaggy_jenkins'
|
548
|
+
# setup authorization
|
549
|
+
SwaggyJenkinsClient.configure do |config|
|
550
|
+
# Configure HTTP basic authorization: jenkins_auth
|
551
|
+
config.username = 'YOUR USERNAME'
|
552
|
+
config.password = 'YOUR PASSWORD'
|
553
|
+
end
|
554
|
+
|
555
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
556
|
+
|
557
|
+
name = "name_example" # String | Name of the view
|
558
|
+
|
559
|
+
|
560
|
+
begin
|
561
|
+
result = api_instance.get_view_config(name, )
|
562
|
+
p result
|
563
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
564
|
+
puts "Exception when calling RemoteAccessApi->get_view_config: #{e}"
|
565
|
+
end
|
566
|
+
```
|
567
|
+
|
568
|
+
### Parameters
|
569
|
+
|
570
|
+
Name | Type | Description | Notes
|
571
|
+
------------- | ------------- | ------------- | -------------
|
572
|
+
**name** | **String**| Name of the view |
|
573
|
+
|
574
|
+
### Return type
|
575
|
+
|
576
|
+
**String**
|
577
|
+
|
578
|
+
### Authorization
|
579
|
+
|
580
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
581
|
+
|
582
|
+
### HTTP request headers
|
583
|
+
|
584
|
+
- **Content-Type**: Not defined
|
585
|
+
- **Accept**: text/xml
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
# **head_jenkins**
|
590
|
+
> head_jenkins
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
Retrieve Jenkins headers
|
595
|
+
|
596
|
+
### Example
|
597
|
+
```ruby
|
598
|
+
# load the gem
|
599
|
+
require 'swaggy_jenkins'
|
600
|
+
# setup authorization
|
601
|
+
SwaggyJenkinsClient.configure do |config|
|
602
|
+
# Configure HTTP basic authorization: jenkins_auth
|
603
|
+
config.username = 'YOUR USERNAME'
|
604
|
+
config.password = 'YOUR PASSWORD'
|
605
|
+
end
|
606
|
+
|
607
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
608
|
+
|
609
|
+
begin
|
610
|
+
api_instance.head_jenkins
|
611
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
612
|
+
puts "Exception when calling RemoteAccessApi->head_jenkins: #{e}"
|
613
|
+
end
|
614
|
+
```
|
615
|
+
|
616
|
+
### Parameters
|
617
|
+
This endpoint does not need any parameter.
|
618
|
+
|
619
|
+
### Return type
|
620
|
+
|
621
|
+
nil (empty response body)
|
622
|
+
|
623
|
+
### Authorization
|
624
|
+
|
625
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
626
|
+
|
627
|
+
### HTTP request headers
|
628
|
+
|
629
|
+
- **Content-Type**: Not defined
|
630
|
+
- **Accept**: Not defined
|
631
|
+
|
632
|
+
|
633
|
+
|
634
|
+
# **post_create_item**
|
635
|
+
> post_create_item(name, opts)
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
Create a new job using job configuration, or copied from an existing job
|
640
|
+
|
641
|
+
### Example
|
642
|
+
```ruby
|
643
|
+
# load the gem
|
644
|
+
require 'swaggy_jenkins'
|
645
|
+
# setup authorization
|
646
|
+
SwaggyJenkinsClient.configure do |config|
|
647
|
+
# Configure HTTP basic authorization: jenkins_auth
|
648
|
+
config.username = 'YOUR USERNAME'
|
649
|
+
config.password = 'YOUR PASSWORD'
|
650
|
+
end
|
651
|
+
|
652
|
+
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
|
662
|
+
}
|
663
|
+
|
664
|
+
begin
|
665
|
+
api_instance.post_create_item(name, opts)
|
666
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
667
|
+
puts "Exception when calling RemoteAccessApi->post_create_item: #{e}"
|
668
|
+
end
|
669
|
+
```
|
670
|
+
|
671
|
+
### Parameters
|
672
|
+
|
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 'copy' 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]
|
681
|
+
|
682
|
+
### Return type
|
683
|
+
|
684
|
+
nil (empty response body)
|
685
|
+
|
686
|
+
### Authorization
|
687
|
+
|
688
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
689
|
+
|
690
|
+
### HTTP request headers
|
691
|
+
|
692
|
+
- **Content-Type**: Not defined
|
693
|
+
- **Accept**: text/html
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
# **post_create_view**
|
698
|
+
> post_create_view(name, opts)
|
699
|
+
|
700
|
+
|
701
|
+
|
702
|
+
Create a new view using view configuration
|
703
|
+
|
704
|
+
### Example
|
705
|
+
```ruby
|
706
|
+
# load the gem
|
707
|
+
require 'swaggy_jenkins'
|
708
|
+
# setup authorization
|
709
|
+
SwaggyJenkinsClient.configure do |config|
|
710
|
+
# Configure HTTP basic authorization: jenkins_auth
|
711
|
+
config.username = 'YOUR USERNAME'
|
712
|
+
config.password = 'YOUR PASSWORD'
|
713
|
+
end
|
714
|
+
|
715
|
+
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
|
723
|
+
}
|
724
|
+
|
725
|
+
begin
|
726
|
+
api_instance.post_create_view(name, opts)
|
727
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
728
|
+
puts "Exception when calling RemoteAccessApi->post_create_view: #{e}"
|
729
|
+
end
|
730
|
+
```
|
731
|
+
|
732
|
+
### Parameters
|
733
|
+
|
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]
|
740
|
+
|
741
|
+
### Return type
|
742
|
+
|
743
|
+
nil (empty response body)
|
744
|
+
|
745
|
+
### Authorization
|
746
|
+
|
747
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
748
|
+
|
749
|
+
### HTTP request headers
|
750
|
+
|
751
|
+
- **Content-Type**: Not defined
|
752
|
+
- **Accept**: text/html
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
# **post_job_build**
|
757
|
+
> post_job_build(name, json, opts)
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
Build a job
|
762
|
+
|
763
|
+
### Example
|
764
|
+
```ruby
|
765
|
+
# load the gem
|
766
|
+
require 'swaggy_jenkins'
|
767
|
+
# setup authorization
|
768
|
+
SwaggyJenkinsClient.configure do |config|
|
769
|
+
# Configure HTTP basic authorization: jenkins_auth
|
770
|
+
config.username = 'YOUR USERNAME'
|
771
|
+
config.password = 'YOUR PASSWORD'
|
772
|
+
end
|
773
|
+
|
774
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
775
|
+
|
776
|
+
name = "name_example" # String | Name of the job
|
777
|
+
|
778
|
+
json = "json_example" # String |
|
779
|
+
|
780
|
+
opts = {
|
781
|
+
token: "token_example", # String |
|
782
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
783
|
+
}
|
784
|
+
|
785
|
+
begin
|
786
|
+
api_instance.post_job_build(name, json, opts)
|
787
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
788
|
+
puts "Exception when calling RemoteAccessApi->post_job_build: #{e}"
|
789
|
+
end
|
790
|
+
```
|
791
|
+
|
792
|
+
### Parameters
|
793
|
+
|
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]
|
800
|
+
|
801
|
+
### Return type
|
802
|
+
|
803
|
+
nil (empty response body)
|
804
|
+
|
805
|
+
### Authorization
|
806
|
+
|
807
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
808
|
+
|
809
|
+
### HTTP request headers
|
810
|
+
|
811
|
+
- **Content-Type**: Not defined
|
812
|
+
- **Accept**: Not defined
|
813
|
+
|
814
|
+
|
815
|
+
|
816
|
+
# **post_job_config**
|
817
|
+
> post_job_config(name, body, opts)
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
Update job configuration
|
822
|
+
|
823
|
+
### Example
|
824
|
+
```ruby
|
825
|
+
# load the gem
|
826
|
+
require 'swaggy_jenkins'
|
827
|
+
# setup authorization
|
828
|
+
SwaggyJenkinsClient.configure do |config|
|
829
|
+
# Configure HTTP basic authorization: jenkins_auth
|
830
|
+
config.username = 'YOUR USERNAME'
|
831
|
+
config.password = 'YOUR PASSWORD'
|
832
|
+
end
|
833
|
+
|
834
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
835
|
+
|
836
|
+
name = "name_example" # String | Name of the job
|
837
|
+
|
838
|
+
body = "body_example" # String | Job configuration in config.xml format
|
839
|
+
|
840
|
+
opts = {
|
841
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
842
|
+
}
|
843
|
+
|
844
|
+
begin
|
845
|
+
api_instance.post_job_config(name, body, opts)
|
846
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
847
|
+
puts "Exception when calling RemoteAccessApi->post_job_config: #{e}"
|
848
|
+
end
|
849
|
+
```
|
850
|
+
|
851
|
+
### Parameters
|
852
|
+
|
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]
|
858
|
+
|
859
|
+
### Return type
|
860
|
+
|
861
|
+
nil (empty response body)
|
862
|
+
|
863
|
+
### Authorization
|
864
|
+
|
865
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
866
|
+
|
867
|
+
### HTTP request headers
|
868
|
+
|
869
|
+
- **Content-Type**: Not defined
|
870
|
+
- **Accept**: text/xml
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
# **post_job_delete**
|
875
|
+
> post_job_delete(name, , opts)
|
876
|
+
|
877
|
+
|
878
|
+
|
879
|
+
Delete a job
|
880
|
+
|
881
|
+
### Example
|
882
|
+
```ruby
|
883
|
+
# load the gem
|
884
|
+
require 'swaggy_jenkins'
|
885
|
+
# setup authorization
|
886
|
+
SwaggyJenkinsClient.configure do |config|
|
887
|
+
# Configure HTTP basic authorization: jenkins_auth
|
888
|
+
config.username = 'YOUR USERNAME'
|
889
|
+
config.password = 'YOUR PASSWORD'
|
890
|
+
end
|
891
|
+
|
892
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
893
|
+
|
894
|
+
name = "name_example" # String | Name of the job
|
895
|
+
|
896
|
+
opts = {
|
897
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
898
|
+
}
|
899
|
+
|
900
|
+
begin
|
901
|
+
api_instance.post_job_delete(name, , opts)
|
902
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
903
|
+
puts "Exception when calling RemoteAccessApi->post_job_delete: #{e}"
|
904
|
+
end
|
905
|
+
```
|
906
|
+
|
907
|
+
### Parameters
|
908
|
+
|
909
|
+
Name | Type | Description | Notes
|
910
|
+
------------- | ------------- | ------------- | -------------
|
911
|
+
**name** | **String**| Name of the job |
|
912
|
+
**jenkins_crumb** | **String**| CSRF protection token | [optional]
|
913
|
+
|
914
|
+
### Return type
|
915
|
+
|
916
|
+
nil (empty response body)
|
917
|
+
|
918
|
+
### Authorization
|
919
|
+
|
920
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
921
|
+
|
922
|
+
### HTTP request headers
|
923
|
+
|
924
|
+
- **Content-Type**: Not defined
|
925
|
+
- **Accept**: Not defined
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
# **post_job_disable**
|
930
|
+
> post_job_disable(name, , opts)
|
931
|
+
|
932
|
+
|
933
|
+
|
934
|
+
Disable a job
|
935
|
+
|
936
|
+
### Example
|
937
|
+
```ruby
|
938
|
+
# load the gem
|
939
|
+
require 'swaggy_jenkins'
|
940
|
+
# setup authorization
|
941
|
+
SwaggyJenkinsClient.configure do |config|
|
942
|
+
# Configure HTTP basic authorization: jenkins_auth
|
943
|
+
config.username = 'YOUR USERNAME'
|
944
|
+
config.password = 'YOUR PASSWORD'
|
945
|
+
end
|
946
|
+
|
947
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
948
|
+
|
949
|
+
name = "name_example" # String | Name of the job
|
950
|
+
|
951
|
+
opts = {
|
952
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
953
|
+
}
|
954
|
+
|
955
|
+
begin
|
956
|
+
api_instance.post_job_disable(name, , opts)
|
957
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
958
|
+
puts "Exception when calling RemoteAccessApi->post_job_disable: #{e}"
|
959
|
+
end
|
960
|
+
```
|
961
|
+
|
962
|
+
### Parameters
|
963
|
+
|
964
|
+
Name | Type | Description | Notes
|
965
|
+
------------- | ------------- | ------------- | -------------
|
966
|
+
**name** | **String**| Name of the job |
|
967
|
+
**jenkins_crumb** | **String**| CSRF protection token | [optional]
|
968
|
+
|
969
|
+
### Return type
|
970
|
+
|
971
|
+
nil (empty response body)
|
972
|
+
|
973
|
+
### Authorization
|
974
|
+
|
975
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
976
|
+
|
977
|
+
### HTTP request headers
|
978
|
+
|
979
|
+
- **Content-Type**: Not defined
|
980
|
+
- **Accept**: Not defined
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
# **post_job_enable**
|
985
|
+
> post_job_enable(name, , opts)
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
Enable a job
|
990
|
+
|
991
|
+
### Example
|
992
|
+
```ruby
|
993
|
+
# load the gem
|
994
|
+
require 'swaggy_jenkins'
|
995
|
+
# setup authorization
|
996
|
+
SwaggyJenkinsClient.configure do |config|
|
997
|
+
# Configure HTTP basic authorization: jenkins_auth
|
998
|
+
config.username = 'YOUR USERNAME'
|
999
|
+
config.password = 'YOUR PASSWORD'
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
1003
|
+
|
1004
|
+
name = "name_example" # String | Name of the job
|
1005
|
+
|
1006
|
+
opts = {
|
1007
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
1008
|
+
}
|
1009
|
+
|
1010
|
+
begin
|
1011
|
+
api_instance.post_job_enable(name, , opts)
|
1012
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1013
|
+
puts "Exception when calling RemoteAccessApi->post_job_enable: #{e}"
|
1014
|
+
end
|
1015
|
+
```
|
1016
|
+
|
1017
|
+
### Parameters
|
1018
|
+
|
1019
|
+
Name | Type | Description | Notes
|
1020
|
+
------------- | ------------- | ------------- | -------------
|
1021
|
+
**name** | **String**| Name of the job |
|
1022
|
+
**jenkins_crumb** | **String**| CSRF protection token | [optional]
|
1023
|
+
|
1024
|
+
### Return type
|
1025
|
+
|
1026
|
+
nil (empty response body)
|
1027
|
+
|
1028
|
+
### Authorization
|
1029
|
+
|
1030
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1031
|
+
|
1032
|
+
### HTTP request headers
|
1033
|
+
|
1034
|
+
- **Content-Type**: Not defined
|
1035
|
+
- **Accept**: Not defined
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
# **post_job_last_build_stop**
|
1040
|
+
> post_job_last_build_stop(name, , opts)
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
Stop a job
|
1045
|
+
|
1046
|
+
### Example
|
1047
|
+
```ruby
|
1048
|
+
# load the gem
|
1049
|
+
require 'swaggy_jenkins'
|
1050
|
+
# setup authorization
|
1051
|
+
SwaggyJenkinsClient.configure do |config|
|
1052
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1053
|
+
config.username = 'YOUR USERNAME'
|
1054
|
+
config.password = 'YOUR PASSWORD'
|
1055
|
+
end
|
1056
|
+
|
1057
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
1058
|
+
|
1059
|
+
name = "name_example" # String | Name of the job
|
1060
|
+
|
1061
|
+
opts = {
|
1062
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
1063
|
+
}
|
1064
|
+
|
1065
|
+
begin
|
1066
|
+
api_instance.post_job_last_build_stop(name, , opts)
|
1067
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1068
|
+
puts "Exception when calling RemoteAccessApi->post_job_last_build_stop: #{e}"
|
1069
|
+
end
|
1070
|
+
```
|
1071
|
+
|
1072
|
+
### Parameters
|
1073
|
+
|
1074
|
+
Name | Type | Description | Notes
|
1075
|
+
------------- | ------------- | ------------- | -------------
|
1076
|
+
**name** | **String**| Name of the job |
|
1077
|
+
**jenkins_crumb** | **String**| CSRF protection token | [optional]
|
1078
|
+
|
1079
|
+
### Return type
|
1080
|
+
|
1081
|
+
nil (empty response body)
|
1082
|
+
|
1083
|
+
### Authorization
|
1084
|
+
|
1085
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1086
|
+
|
1087
|
+
### HTTP request headers
|
1088
|
+
|
1089
|
+
- **Content-Type**: Not defined
|
1090
|
+
- **Accept**: Not defined
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
# **post_view_config**
|
1095
|
+
> post_view_config(name, body, opts)
|
1096
|
+
|
1097
|
+
|
1098
|
+
|
1099
|
+
Update view configuration
|
1100
|
+
|
1101
|
+
### Example
|
1102
|
+
```ruby
|
1103
|
+
# load the gem
|
1104
|
+
require 'swaggy_jenkins'
|
1105
|
+
# setup authorization
|
1106
|
+
SwaggyJenkinsClient.configure do |config|
|
1107
|
+
# Configure HTTP basic authorization: jenkins_auth
|
1108
|
+
config.username = 'YOUR USERNAME'
|
1109
|
+
config.password = 'YOUR PASSWORD'
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
api_instance = SwaggyJenkinsClient::RemoteAccessApi.new
|
1113
|
+
|
1114
|
+
name = "name_example" # String | Name of the view
|
1115
|
+
|
1116
|
+
body = "body_example" # String | View configuration in config.xml format
|
1117
|
+
|
1118
|
+
opts = {
|
1119
|
+
jenkins_crumb: "jenkins_crumb_example" # String | CSRF protection token
|
1120
|
+
}
|
1121
|
+
|
1122
|
+
begin
|
1123
|
+
api_instance.post_view_config(name, body, opts)
|
1124
|
+
rescue SwaggyJenkinsClient::ApiError => e
|
1125
|
+
puts "Exception when calling RemoteAccessApi->post_view_config: #{e}"
|
1126
|
+
end
|
1127
|
+
```
|
1128
|
+
|
1129
|
+
### Parameters
|
1130
|
+
|
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]
|
1136
|
+
|
1137
|
+
### Return type
|
1138
|
+
|
1139
|
+
nil (empty response body)
|
1140
|
+
|
1141
|
+
### Authorization
|
1142
|
+
|
1143
|
+
[jenkins_auth](../README.md#jenkins_auth)
|
1144
|
+
|
1145
|
+
### HTTP request headers
|
1146
|
+
|
1147
|
+
- **Content-Type**: Not defined
|
1148
|
+
- **Accept**: Not defined
|
1149
|
+
|
1150
|
+
|
1151
|
+
|