Skip to content

Commit

Permalink
Merge pull request #24 from eea/develop
Browse files Browse the repository at this point in the history
feat(serializer): added effective to the default_metadata_fields
  • Loading branch information
avoinea authored May 16, 2024
2 parents 203b403 + 76fe59f commit 62add4a
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/HISTORY.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Changelog
=========

3.5 - (2024-05-14)
---------------------------
* Change: feat(serializer): added effective to the default_metadata_fields
[ichim-david]

3.4 - (2024-03-28)
---------------------------
* Change: Develop typo
Expand Down
4 changes: 4 additions & 0 deletions eea/volto/policy/restapi/serializer/configure.zcml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,9 @@
>

<adapter factory=".dxfields.DateTimeFieldSerializer" />
<utility
factory=".summary.EEAJSONSummarySerializerMetadata"
name="plone.restapi.eea_summary_serializer_metadata"
/>

</configure>
30 changes: 30 additions & 0 deletions eea/volto/policy/restapi/serializer/summary.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""Summary serializer metadata for EEA Volto Policy."""
from plone.restapi.interfaces import IJSONSummarySerializerMetadata
from plone.restapi.serializer.summary import JSONSummarySerializerMetadata
from zope.interface import implementer


@implementer(IJSONSummarySerializerMetadata)
class EEAJSONSummarySerializerMetadata(JSONSummarySerializerMetadata):
"""
Summary Metadata serializer inherited within EEA Volto Policy.
Implements IJSONSummarySerializerMetadata interface.
"""

def default_metadata_fields(self):
"""
Returns a set of default metadata fields to be included in the summary.
We add effective date to the list of default fields.
Returns:
set: A set of metadata field names.
"""
return {
"@id",
"@type",
"description",
"review_state",
"title",
"type_title",
"effective",
}
2 changes: 1 addition & 1 deletion eea/volto/policy/version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.4
3.5

0 comments on commit 62add4a

Please sign in to comment.