Skip to content

README and implementation mismatch: manual cronjob execution uses GET instead of POST #74

@Rayjay-8

Description

@Rayjay-8

The README currently states that the endpoint to manually execute a cronjob is:

POST /api/cronjobs/:id/execute

However, after reviewing the code, the actual implementation exposes this operation using GET.

This creates a mismatch between the documentation and the real API behavior, which can be confusing for users integrating with or contributing to the project.

Proposal:
Open a discussion to decide which approach is more appropriate:
Option A: Update the code to use POST, aligning the implementation with the README and REST best practices.
Option B: Update the README to reflect the use of GET, clearly documenting the rationale behind this choice.
Option C: Consider an alternative design (e.g. POST /api/cronjobs/:id/executions or similar).

Metadata

Metadata

Assignees

No one assigned

    Labels

    AcceptedThis task has been acceptedNext releaseThis task will come in the next release

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions