Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the metadata block on specialist documents optional #3241

Merged
merged 2 commits into from
Apr 1, 2025
Merged

Make the metadata block on specialist documents optional #3241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a86126f
Add show_metadata_block property to Specialist Finders
GDSNewt Mar 28, 2025
a3a84bd
Amend specialist document examples for new metadatablock property
GDSNewt Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content_schemas/dist/formats/finder/frontend/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,9 @@
"reject": {
"$ref": "#/definitions/finder_reject_filter"
},
"show_metadata_block": {
"$ref": "#/definitions/finder_show_metadata_block"
},
"show_summaries": {
"$ref": "#/definitions/finder_show_summaries"
},
Expand Down Expand Up @@ -618,6 +621,9 @@
}
}
},
"finder_show_metadata_block": {
"type": "boolean"
},
"finder_show_summaries": {
"type": "boolean"
},
Expand Down
6 changes: 6 additions & 0 deletions content_schemas/dist/formats/finder/notification/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,9 @@
"reject": {
"$ref": "#/definitions/finder_reject_filter"
},
"show_metadata_block": {
"$ref": "#/definitions/finder_show_metadata_block"
},
"show_summaries": {
"$ref": "#/definitions/finder_show_summaries"
},
Expand Down Expand Up @@ -718,6 +721,9 @@
}
}
},
"finder_show_metadata_block": {
"type": "boolean"
},
"finder_show_summaries": {
"type": "boolean"
},
Expand Down
6 changes: 6 additions & 0 deletions content_schemas/dist/formats/finder/publisher_v2/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,9 @@
"reject": {
"$ref": "#/definitions/finder_reject_filter"
},
"show_metadata_block": {
"$ref": "#/definitions/finder_show_metadata_block"
},
"show_summaries": {
"$ref": "#/definitions/finder_show_summaries"
},
Expand Down Expand Up @@ -510,6 +513,9 @@
}
}
},
"finder_show_metadata_block": {
"type": "boolean"
},
"finder_show_summaries": {
"type": "boolean"
},
Expand Down
3 changes: 2 additions & 1 deletion content_schemas/examples/specialist_document/frontend/countryside-stewardship-grants.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,8 @@
}
]
}
]
],
"show_metadata_block": true
},
"links": {
},
Expand Down
3 changes: 2 additions & 1 deletion content_schemas/examples/specialist_document/frontend/drug-device-alerts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,8 @@
"display_as_result_metadata": true,
"filterable": true
}
]
],
"show_metadata_block": true
},
"links": {
},
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/formats/finder.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@
show_summaries: {
"$ref": "#/definitions/finder_show_summaries",
},
show_metadata_block: {
"$ref": "#/definitions/finder_show_metadata_block",
},
signup_link: {
"$ref": "#/definitions/finder_signup_link",
},
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/formats/shared/definitions/finder.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,9 @@
finder_show_summaries: {
type: "boolean",
},
finder_show_metadata_block: {
type: "boolean",
},
finder_signup_link: {
anyOf: [
{
Expand Down
2 changes: 1 addition & 1 deletion lib/expansion_rules.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def details_fields(*fields)
ORGANISATION_FIELDS = (DEFAULT_FIELDS - [:public_updated_at] + details_fields(:acronym, :logo, :brand, :default_news_image, :organisation_govuk_status)).freeze
TAXON_FIELDS = (DEFAULT_FIELDS + %i[description details phase]).freeze
NEED_FIELDS = (DEFAULT_FIELDS + details_fields(:role, :goal, :benefit, :met_when, :justifications)).freeze
FINDER_FIELDS = (DEFAULT_FIELDS + details_fields(:facets)).freeze
FINDER_FIELDS = (DEFAULT_FIELDS + details_fields(:facets, :show_metadata_block)).freeze
FATALITY_NOTICE_FIELDS = (DEFAULT_FIELDS + details_fields(:roll_call_introduction, :casualties))
HISTORIC_APPOINTMENT_FIELDS = (DEFAULT_FIELDS + details_fields(:political_party, :dates_in_office))
MINISTERIAL_ROLE_FIELDS = (DEFAULT_FIELDS + details_fields(:body, :role_payment_type, :seniority, :whip_organisation)).freeze
Expand Down
2 changes: 1 addition & 1 deletion spec/lib/expansion_rules_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
let(:default_fields_and_description) { default_fields + %i[description] }
let(:need_fields) { default_fields + [%i[details role], %i[details goal], %i[details benefit], %i[details met_when], %i[details justifications]] }
let(:fatality_notice_fields) { default_fields + [%i[details roll_call_introduction], %i[details casualties]] }
let(:finder_fields) { default_fields + [%i[details facets]] }
let(:finder_fields) { default_fields + [%i[details facets], %i[details show_metadata_block]] }
let(:historic_appointment_fields) { default_fields + [%i[details political_party], %i[details dates_in_office]] }
let(:ministerial_role_fields) { role_fields + [%i[details seniority], %i[details whip_organisation]] }
let(:person_fields) { default_fields + [%i[details body], %i[details image]] }
Expand Down