swaggyjenkins 3.3.0

Swaggy Jenkins

swaggyjenkins

Jenkins API clients generated from Swagger / Open API specification

This Python package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/oapicf/swaggy-jenkins.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/oapicf/swaggy-jenkins.git)

Then import the package:

import swaggyjenkins

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swaggyjenkins

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import swaggyjenkins
from swaggyjenkins.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = swaggyjenkins.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: jenkins_auth
configuration = swaggyjenkins.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with swaggyjenkins.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = swaggyjenkins.BaseApi(api_client)

    try:
        api_response = api_instance.get_crumb()
        print("The response of BaseApi->get_crumb:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BaseApi->get_crumb: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

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

Documentation For Models

• AllView
• BranchImpl
• BranchImpllinks
• BranchImplpermissions
• CauseAction
• CauseUserIdCause
• ClassesByClass
• ClockDifference
• ComputerSet
• DefaultCrumbIssuer
• DiskSpaceMonitorDescriptorDiskSpace
• EmptyChangeLogSet
• ExtensionClassContainerImpl1
• ExtensionClassContainerImpl1links
• ExtensionClassContainerImpl1map
• ExtensionClassImpl
• ExtensionClassImpllinks
• FavoriteImpl
• FavoriteImpllinks
• FreeStyleBuild
• FreeStyleProject
• FreeStyleProjectactions
• FreeStyleProjecthealthReport
• GenericResource
• GithubContent
• GithubFile
• GithubOrganization
• GithubOrganizationlinks
• GithubRepositories
• GithubRepositorieslinks
• GithubRepository
• GithubRepositorylinks
• GithubRepositorypermissions
• GithubRespositoryContainer
• GithubRespositoryContainerlinks
• GithubScm
• GithubScmlinks
• Hudson
• HudsonMasterComputer
• HudsonMasterComputerexecutors
• HudsonMasterComputermonitorData
• HudsonassignedLabels
• InputStepImpl
• InputStepImpllinks
• Label1
• Link
• ListView
• MultibranchPipeline
• NullSCM
• Organisation
• Pipeline
• PipelineActivity
• PipelineActivityartifacts
• PipelineBranchesitem
• PipelineBranchesitemlatestRun
• PipelineBranchesitempullRequest
• PipelineBranchesitempullRequestlinks
• PipelineFolderImpl
• PipelineImpl
• PipelineImpllinks
• PipelineRun
• PipelineRunImpl
• PipelineRunImpllinks
• PipelineRunNode
• PipelineRunNodeedges
• PipelineRunartifacts
• PipelineStepImpl
• PipelineStepImpllinks
• PipelinelatestRun
• PipelinelatestRunartifacts
• Queue
• QueueBlockedItem
• QueueItemImpl
• QueueLeftItem
• ResponseTimeMonitorData
• StringParameterDefinition
• StringParameterValue
• SwapSpaceMonitorMemoryUsage2
• UnlabeledLoadStatistics
• User

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

Author

[e-mail]