jenkinsci / jenkinsci/lockable-resources-plugin
Is there any API documentation on what is supported? Can this be used from command line outside of jenkins?
- Dominant language
- Java
- Stars
- 99
- Forks
- 205
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 8
Description
### Describe your use-case which is not covered by existing documentation.
I cant find any documentation on what APIs are supported to access Jenkins Lockable Resources from outside of the Jenkins environment.
The overview part seems a little confusing as well since the Jenkins deployment with the lockable resources page does not specify the options mentioned here
[overview page](https://github.com/jenkinsci/lockable-resources-plugin/?tab=readme-ov-file#lockable-resources-overview)
Can this be triggered using a call to cURL or wget etc. The python library to use this also seem pretty old.
[pip module](https://pypi.org/project/jenkins-lockable-resources/#description)
### Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.
[sample api](https://ci.jenkins.io/api/)
### Are you interested in contributing to the documentation?
I am very open to contributing to documenting this further.
Contributor guide
Research direction
Start with the lockable-resources overview README and the linked Jenkins sample API, then compare them with the current plugin behavior and the referenced Python module. Document which APIs are supported outside Jenkins, whether curl or wget can trigger them, and clarify the deployment options so the documentation answers these use cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100