Feature Request: Dedicated Options API for Jobs

[ranjithrajv]

Is this feature request related to a problem?

The current(v47) Rundeck API offers limited ways to access information about job options.

While job options as optional parameters (
option.OPTNAME: Option value for option named OPTNAME. If any option.OPTNAME parameters are specified, the argString value is ignored (API v18 or later).)

can be used with specific POST endpoints like

POST /api/14/job/[ID]/run
POST /api/12/job/[ID]/executions

retrieving detailed option metadata requires additional API calls or parsing job configurations. This can be cumbersome and inefficient for developers and automation tools working with Rundeck jobs.

Proposed Solution

This request proposes creating a dedicated Options API for Rundeck jobs. This API would enable programmatic retrieval of comprehensive information about the options associated with a specific job.

Alternatives Considered

• Using optional parameters with specific POST endpoints (limited functionality and requires additional calls).
• Parsing job configurations (complex and error-prone).

Additional Context

A dedicated Options API would:

• Improve developer experience by providing a dedicated and efficient way to access option information.
• Increase flexibility for automation tools and scripting to manage job options programmatically.
• Enhance understanding of job configuration requirements through detailed option metadata.

Note:

• Clear and concise API documentation for the new endpoint and response format is requested.
• Authentication method (e.g., API keys, OAuth) can be discussed further.
• Error handling with expected error codes and responses is essential.

Implementing this Options API would make Rundeck more developer-friendly and enable more powerful automation scenarios involving job options and configurations.