Skip to content

Commit

Permalink
Remove unused format_name property
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisBAshton committed Jan 30, 2025
1 parent 09f6a1a commit 23b6ca0
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion source/manual/finder_schema_breakdown.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ The current schema for finders is defined within the [Publishing API repository]
| |open_filter_on_load: {type: "boolean",},| Add the open_filter_on_load property to automatically open filters on mobile when the page loads. This configuration is specific to the Find a Licence (specialist finder) only. |
| |reject: {"$ref": "#/definitions/finder_reject_filter",},| The finder_reject_filter object defines a filter that excludes documents based on specified criteria. It includes arrays of strings for properties like content purpose, document types, email document supertype, policies, and links. The object does not allow additional properties to ensure strict adherence to the defined criteria. |
| |facets: {"$ref": "#/definitions/finder_facets",},| The finder_facets array defines the facets available for users to refine their search. Each facet is an object that includes several properties: key, which specifies the field name used for the facet; filterable, indicating whether the facet should be shown to users; display_as_result_metadata, which determines if the facet appears in search result metadata; name, the label for the facet; and type, which defines the UI component and query method, such as checkbox, date, or autocomplete. Additionally, the allowed_values property lists possible values for non-dynamic facets, while combine_mode specifies how the facet combines with others, using options like "and" or "or". Other options control aspects of the facet’s appearance and behavior, such as whether it opens on page load or hides facet tags. |
| |format_name: {type: "string",},| An optional string, typically a singularized version of the Finder's title, such as "Competition and Markets Authority case" for /cma-cases. While it is generally aligned with the Finder’s title, there are exceptions like "Medical safety alert" for Alerts and recalls for drugs and medical devices. |
| |label_text: {type: "string",},| Adds a label_text property to rename the label from "Search" to "Keywords" specifically for the licence finder (specialist finder), helping users understand they should enter keywords rather than using it as a general search box. |
| |show_summaries: {"$ref": "#/definitions/finder_show_summaries",},| A boolean that determines whether summaries for documents should be displayed in the results list, truncating each summary at the end of the first sentence. |
| |signup_link: {"$ref": "#/definitions/finder_signup_link",},| This property enables finder-frontend to override the default email signup link if necessary. [Here](https://www.gov.uk/drug-safety-update) is an example of where it is used. You can view its implementation in the code [here](https://github.com/alphagov/specialist-publisher/blob/main/lib/documents/schemas/drug_safety_updates.json#L11). |
Expand Down

0 comments on commit 23b6ca0

Please sign in to comment.