plone / plone/plone.restapi

Specialise ISerializeToJson

Open
#331 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
109
Forks
107
Avg merge
2d 3h
Merged PRs (30d)
4

Description

We have multiple ISerializeToJson implementations with different signatures for __call__.
For content objects we require a version_id in __call__.
BrainSerializer needs metadata_fields, as does LazyCatalogResultSerializer.
SerializeVocabularyToJson and SerializeTermToJson need vocabulary_id.

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

Locate the ISerializeToJson interface and its implementations, including the content serializers, BrainSerializer, LazyCatalogResultSerializer, SerializeVocabularyToJson, and SerializeTermToJson. Compare their call signatures and the existing serializer tests; the work is done when the interface and implementations consistently represent their required arguments without breaking those tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.