swaggy_jenkins

SwaggyJenkinsClient - the Ruby gem for the Swaggy Jenkins

Jenkins API clients generated from Swagger / Open API specification

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.1
  • Package version: 3.0.1
  • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/oapicf/swaggy-jenkins

Installation

Build a gem

To build the Ruby code into a gem:

gem build swaggy_jenkins.gemspec

Then either install the gem locally:

gem install ./swaggy_jenkins-3.0.1.gem

(for development, run gem install --dev ./swaggy_jenkins-3.0.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swaggy_jenkins', '~> 3.0.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swaggy_jenkins', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swaggy_jenkins'

# Setup authorization
SwaggyJenkinsClient.configure do |config|
  # Configure HTTP basic authorization: jenkins_auth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
end

api_instance = SwaggyJenkinsClient::BaseApi.new

begin
  result = api_instance.get_crumb
  p result
rescue SwaggyJenkinsClient::ApiError => e
  puts "Exception when calling BaseApi->get_crumb: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
SwaggyJenkinsClient::BaseApi get_crumb GET /crumbIssuer/api/json
SwaggyJenkinsClient::BlueOceanApi delete_pipeline_queue_item DELETE /blue/rest/organizations/organization/pipelines/pipeline/queue/queue
SwaggyJenkinsClient::BlueOceanApi get_authenticated_user GET /blue/rest/organizations/organization/user/
SwaggyJenkinsClient::BlueOceanApi get_classes GET /blue/rest/classes/class
SwaggyJenkinsClient::BlueOceanApi get_json_web_key GET /jwt-auth/jwks/key
SwaggyJenkinsClient::BlueOceanApi get_json_web_token GET /jwt-auth/token
SwaggyJenkinsClient::BlueOceanApi get_organisation GET /blue/rest/organizations/organization
SwaggyJenkinsClient::BlueOceanApi get_organisations GET /blue/rest/organizations/
SwaggyJenkinsClient::BlueOceanApi get_pipeline GET /blue/rest/organizations/organization/pipelines/pipeline
SwaggyJenkinsClient::BlueOceanApi get_pipeline_activities GET /blue/rest/organizations/organization/pipelines/pipeline/activities
SwaggyJenkinsClient::BlueOceanApi get_pipeline_branch GET /blue/rest/organizations/organization/pipelines/pipeline/branches/branch/
SwaggyJenkinsClient::BlueOceanApi get_pipeline_branch_run GET /blue/rest/organizations/organization/pipelines/pipeline/branches/branch/runs/run
SwaggyJenkinsClient::BlueOceanApi get_pipeline_branches GET /blue/rest/organizations/organization/pipelines/pipeline/branches
SwaggyJenkinsClient::BlueOceanApi get_pipeline_folder GET /blue/rest/organizations/organization/pipelines/folder/
SwaggyJenkinsClient::BlueOceanApi get_pipeline_folder_pipeline GET /blue/rest/organizations/organization/pipelines/folder/pipelines/pipeline
SwaggyJenkinsClient::BlueOceanApi get_pipeline_queue GET /blue/rest/organizations/organization/pipelines/pipeline/queue
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_log GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/log
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_node GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/nodes/node
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_node_step GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/nodes/node/steps/step
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_node_step_log GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/nodes/node/steps/step/log
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_node_steps GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/nodes/node/steps
SwaggyJenkinsClient::BlueOceanApi get_pipeline_run_nodes GET /blue/rest/organizations/organization/pipelines/pipeline/runs/run/nodes
SwaggyJenkinsClient::BlueOceanApi get_pipeline_runs GET /blue/rest/organizations/organization/pipelines/pipeline/runs
SwaggyJenkinsClient::BlueOceanApi get_pipelines GET /blue/rest/organizations/organization/pipelines/
SwaggyJenkinsClient::BlueOceanApi get_scm GET /blue/rest/organizations/organization/scm/scm
SwaggyJenkinsClient::BlueOceanApi get_scm_organisation_repositories GET /blue/rest/organizations/organization/scm/scm/organizations/scmOrganisation/repositories
SwaggyJenkinsClient::BlueOceanApi get_scm_organisation_repository GET /blue/rest/organizations/organization/scm/scm/organizations/scmOrganisation/repositories/repository
SwaggyJenkinsClient::BlueOceanApi get_scm_organisations GET /blue/rest/organizations/organization/scm/scm/organizations
SwaggyJenkinsClient::BlueOceanApi get_user GET /blue/rest/organizations/organization/users/user
SwaggyJenkinsClient::BlueOceanApi get_user_favorites GET /blue/rest/users/user/favorites
SwaggyJenkinsClient::BlueOceanApi get_users GET /blue/rest/organizations/organization/users/
SwaggyJenkinsClient::BlueOceanApi post_pipeline_run POST /blue/rest/organizations/organization/pipelines/pipeline/runs/run/replay
SwaggyJenkinsClient::BlueOceanApi post_pipeline_runs POST /blue/rest/organizations/organization/pipelines/pipeline/runs
SwaggyJenkinsClient::BlueOceanApi put_pipeline_favorite PUT /blue/rest/organizations/organization/pipelines/pipeline/favorite
SwaggyJenkinsClient::BlueOceanApi put_pipeline_run PUT /blue/rest/organizations/organization/pipelines/pipeline/runs/run/stop
SwaggyJenkinsClient::BlueOceanApi search GET /blue/rest/search/
SwaggyJenkinsClient::BlueOceanApi search_classes GET /blue/rest/classes/
SwaggyJenkinsClient::RemoteAccessApi get_computer GET /computer/api/json
SwaggyJenkinsClient::RemoteAccessApi get_jenkins GET /api/json
SwaggyJenkinsClient::RemoteAccessApi get_job GET /job/name/api/json
SwaggyJenkinsClient::RemoteAccessApi get_job_config GET /job/name/config.xml
SwaggyJenkinsClient::RemoteAccessApi get_job_last_build GET /job/name/lastBuild/api/json
SwaggyJenkinsClient::RemoteAccessApi get_job_progressive_text GET /job/name/number/logText/progressiveText
SwaggyJenkinsClient::RemoteAccessApi get_queue GET /queue/api/json
SwaggyJenkinsClient::RemoteAccessApi get_queue_item GET /queue/item/number/api/json
SwaggyJenkinsClient::RemoteAccessApi get_view GET /view/name/api/json
SwaggyJenkinsClient::RemoteAccessApi get_view_config GET /view/name/config.xml
SwaggyJenkinsClient::RemoteAccessApi head_jenkins HEAD /api/json
SwaggyJenkinsClient::RemoteAccessApi post_create_item POST /createItem
SwaggyJenkinsClient::RemoteAccessApi post_create_view POST /createView
SwaggyJenkinsClient::RemoteAccessApi post_job_build POST /job/name/build
SwaggyJenkinsClient::RemoteAccessApi post_job_config POST /job/name/config.xml
SwaggyJenkinsClient::RemoteAccessApi post_job_delete POST /job/name/doDelete
SwaggyJenkinsClient::RemoteAccessApi post_job_disable POST /job/name/disable
SwaggyJenkinsClient::RemoteAccessApi post_job_enable POST /job/name/enable
SwaggyJenkinsClient::RemoteAccessApi post_job_last_build_stop POST /job/name/lastBuild/stop
SwaggyJenkinsClient::RemoteAccessApi post_view_config POST /view/name/config.xml

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

jenkins_auth

  • Type: HTTP basic authentication

jwt_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header