plone / plone/plone.restapi

Expose primaryField information in fully serialized content

Open
#1,318 0 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

The primary field could be used as a signal for the type of information that a particular content item provides. I provide an example of the desired output for a content item serialization:

{
   '@components': {
       'primary_field': 'file',
   },
   file: {
       'content-type': 'application/pdf',
       ...
     }
}

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 fully serialized content implementation in the REST API and its existing serialization tests. Compare its output with the example in this issue, then verify that the primary field is exposed under @components and that the behavior is covered by tests.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.