Skip to content

Commit

Permalink
add instructions_to_publishers to schemas
Browse files Browse the repository at this point in the history 
We want to add a field to all Content Blocks that
will be a short string containing an internal-only
message.

This adds the field `instructions_for_publishers`
to a shared default schema file, and then sets it
as optional on content blocks.

Although this is a Content Block specific field,
it did not make sense to include it in the
`details` object because we are using that schema
for all custom public-facing fields on a block. We
have already set precedent for adding Content
Block specific top level fields with
`content_id_alias`.
  • Loading branch information
@Harriethw
Harriethw committed Nov 11, 2024
1 parent d66be73 commit 4b63ff8
Show file tree
Hide file tree
Showing 89 changed files with 299 additions and 1 deletion.
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/answer/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/calendar/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/call_for_evidence/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/case_study/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/completed_transaction/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/consultation/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/contact/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
13 changes: 13 additions & 0 deletions content_schemas/dist/formats/content_block_email_address/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"$ref": "#/definitions/instructions_to_publishers_optional"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down Expand Up @@ -219,6 +222,16 @@
},
"uniqueItems": true
},
"instructions_to_publishers_optional": {
"anyOf": [
{
"$ref": "#/definitions/content_id_alias"
},
{
"type": "null"
}
]
},
"locale": {
"type": "string",
"enum": [
Expand Down
13 changes: 13 additions & 0 deletions content_schemas/dist/formats/content_block_postal_address/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"$ref": "#/definitions/instructions_to_publishers_optional"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down Expand Up @@ -232,6 +235,16 @@
},
"uniqueItems": true
},
"instructions_to_publishers_optional": {
"anyOf": [
{
"$ref": "#/definitions/content_id_alias"
},
{
"type": "null"
}
]
},
"locale": {
"type": "string",
"enum": [
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/coronavirus_landing_page/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/corporate_information_page/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/detailed_guide/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/document_collection/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/email_alert_signup/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/embassies_index/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/external_content/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/facet/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/fatality_notice/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/field_of_operation/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/fields_of_operation/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/finder/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/finder_email_signup/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/generic/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/get_involved/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/gone/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/government/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/guide/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/help_page/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/historic_appointment/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/historic_appointments/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/history/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/hmrc_manual/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/hmrc_manual_section/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/homepage/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions content_schemas/dist/formats/how_government_works/publisher_v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"instructions_to_publishers": {
"type": "null"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
Expand Down
Loading

0 comments on commit 4b63ff8

Please sign in to comment.