1 stable release

1.0.0	Jun 23, 2022

#239 in #open-api

24 downloads per month
Used in murdock-cli

Apache-2.0

57KB
934 lines

Rust API client for murdock-api

This is the Murdock API

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named murdock-api and add the following to Cargo.toml under [dependencies]:

murdock-api = { path = "./murdock-api" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
BranchJobApi	job_get_last_branch_badge_handler_job_branch_branch_badge_get	GET /job/branch/{branch}/badge	Return the last job badge of the given branch
BranchJobApi	job_get_last_branch_handler_job_branch_branch_get	GET /job/branch/{branch}	Return the last job of the given branch
BranchJobApi	job_start_branch_handler_job_branch_post	POST /job/branch	Start a manual job on a branch
CommitJobApi	job_get_last_commit_handler_job_commit_sha_get	GET /job/commit/{sha}	Return the last job of the given commit
CommitJobApi	job_start_commit_handler_job_commit_post	POST /job/commit	Start a manual job on a tag
JobApi	job_handler_job_uid_get	GET /job/{uid}	Return the details of a job
JobApi	job_remove_handler_job_uid_delete	DELETE /job/{uid}	Remove a job
JobApi	job_restart_handler_job_uid_post	POST /job/{uid}	Restart a finished job
JobApi	running_job_status_handler_job_uid_status_put	PUT /job/{uid}/status	Update the status of a running job
JobsApi	finished_job_delete_handler_jobs_delete	DELETE /jobs	Removed finished jobs older than 'before' date
JobsApi	jobs_handler_jobs_get	GET /jobs	Return the list of all jobs
PrJobApi	job_get_last_prnum_handler_job_pr_prnum_get	GET /job/pr/{prnum}	Return the last job of the given PR number
TagJobApi	job_get_last_tag_handler_job_tag_tag_get	GET /job/tag/{tag}	Return the last job of the given tag
TagJobApi	job_start_tag_handler_job_tag_post	POST /job/tag	Start a manual job on a tag

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~4–18MB
~258K SLoC