plone / plone/plone.api

RFC: api.content.get_history

Open
#305 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
101
Forks
62
Avg merge
15h 15m
Merged PRs (30d)
1

Description

I'm not sure if that fits on the 80/20 rule, but it would helpful to get a get_history method that given an object and workflow name (or automatically get it if not passed), it would return the workflow history.

So basically wrapping Products.CMFPlone.WorkflowTool.WorkflowTool.getHistoryOf but with a nicer looking method name :-)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the api.content entry points and reviewing Products.CMFPlone.WorkflowTool.WorkflowTool.getHistoryOf, which the issue identifies as the underlying operation. Confirm how the workflow name should be handled when omitted, then add coverage showing that api.content.get_history returns the workflow history for the requested object and workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.