changedInput schema / properties / item / description
Previous value: -"Item path {type}/{year}/{number} — ukpga/2018/12, uksi/2019/419, eur/2016/679, ukpga/Eliz2/3-4/19 — or any legislation.gov.uk URI (a URI carrying a provision, version, or /welsh is split into those parts; a version or /welsh in the URI applies unless the version or language input is set). Get it from uklaw_lookup_citation or uklaw_search_legislation."New value: +"Item path {type}/{year}/{number} — ukpga/2018/12, uksi/2019/419, eur/2016/679, ukpga/Eliz2/3-4/19 — or any legislation.gov.uk URI (a URI carrying a provision, version, or /welsh is split into those parts; a version or /welsh in the URI applies unless the version or language input is set). Get it from uklaw_lookup_citation or uklaw_search_legislation. A path legislation.gov.uk serves at another path — a pre-1963 Act by calendar year (ukpga/1925/20 is ukpga/Geo5/15-16/20), a Welsh SI as uksi — is read there, and item.path reports the served path, with a notice."
changedInput schema / properties / version / description
Previous value: -"current (the latest revised text, or the original text for an item never revised), enacted (made, adopted and created are synonyms — the original text), or a date YYYY-MM-DD for the text as it stood then. Omitted: the version in an item URI, else current. A future date returns the latest version, and a date on or after the made or enactment date of an item never revised returns its original text, with a notice; version.applied reports the version served."New value: +"current (the latest revised text, or the original text for an item never revised), enacted (made, adopted and created are synonyms — the original text), or a date YYYY-MM-DD for the text as it stood then. Omitted: the version in an item URI, else current. A future date returns the latest version; a date before the earliest revised version (1991-02-01 for most primary legislation, 2006-01-01 for Northern Ireland) returns that version, with a notice; and a date on or after the made or enactment date of an item never revised returns its original text, with a notice. version.applied reports the version served."
changedOutput schema / properties / editorial / properties / outstanding_effects / description
Previous value: -"Effects requiring a text change not yet applied that touch this provision, or at item level every such effect on the item: the full count, beyond the 20 unapplied_effects lists."New value: +"Effects requiring a text change not yet applied: at provision level those touching the provision, an element enclosing it (Part, Chapter, cross-heading) or a provision inside it; at item level every such effect on the item. The full count, beyond the 20 unapplied_effects lists and the effects inside an outlined provision, which it does not list."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `invalid_item`: item is not a full {type}/{year}/{number} item path or legislation.gov.uk URI, its type code is unknown, or a URI carries an unreadable provision. `invalid_provision`: provision cannot be normalized, or conflicts with a provision embedded in item. `invalid_version`: version is shaped YYYY-MM-DD but is not a real calendar date, or a URI carried an unsupported version. `match_text_needs_item_level`: match_text is combined with provision. `document_not_found`: legislation.gov.uk has no such item, or the identifier check that would tell a missing item from a missing provision could not run in time. `provision_not_found`: The item exists but has no document at that provision path and version. `version_not_found`: Item level: the item exists but has no version at the requested date (the date precedes it). `upstream_refused`: legislation.gov.uk answered 403 or 429 (its fair use rate limit or a block). `pacer_shed`: The shared request queue cannot start this call within its deadline. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `invalid_item`: item is not a full {type}/{year}/{number} item path or legislation.gov.uk URI, its type code is unknown, or a URI carries an unreadable provision. `invalid_provision`: provision cannot be normalized, or conflicts with a provision embedded in item. `invalid_version`: version is shaped YYYY-MM-DD but is not a real calendar date, or a URI carried an unsupported version. `ambiguous_item`: item names more than one item on legislation.gov.uk (a 300), as a pre-1963 calendar year and chapter shared by two parliamentary sessions does: ukpga/1955/19. `match_text_needs_item_level`: match_text is combined with provision. `document_not_found`: legislation.gov.uk has no such item, or the identifier check that would tell a missing item from a missing provision could not run in time. `provision_not_found`: The item exists but has no document at that provision path and version. `version_not_found`: Item level: the item exists but has no version at the requested date (the date precedes it). `upstream_refused`: legislation.gov.uk answered 403 or 429 (its fair use rate limit or a block). `pacer_shed`: The shared request queue cannot start this call within its deadline. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "invalid_item",
- "invalid_provision",
- "invalid_version",
- "match_text_needs_item_level",
- "document_not_found",
- "provision_not_found",
- "version_not_found",
- "upstream_refused",
- "pacer_shed"
-]New value: +[
+ "invalid_item",
+ "invalid_provision",
+ "invalid_version",
+ "ambiguous_item",
+ "match_text_needs_item_level",
+ "document_not_found",
+ "provision_not_found",
+ "version_not_found",
+ "upstream_refused",
+ "pacer_shed"
+]
changedOutput schema / properties / item / properties / path / description
Previous value: -"Item path, e.g. ukpga/2018/12."New value: +"Item path legislation.gov.uk serves the item at, e.g. ukpga/2018/12; a redirected input (ukpga/1925/20 → ukpga/Geo5/15-16/20) reports the served path, with a notice."
changedOutput schema / properties / notice / description
Previous value: -"Notices: Welsh fallback, original text served for a dated read, an omitted provision window, the unapplied effects an item outline leaves out, truncated lists, an outline window with the outline_offset that continues it, an oversized provision with no smaller child provisions returned whole or cut (its full size, and the links to the full text), and how to continue."New value: +"Notices: the path an item input is served at, Welsh fallback, original text served for a dated read, a later version served for a date before the earliest revised version, an omitted provision window, the unapplied effects an item outline or an outlined provision leaves out, unapplied effects on enclosing or contained provisions that could not be checked, how many effects of a multi-page unapplied changes feed were checked, truncated lists, an outline window with the outline_offset that continues it, an oversized provision with no smaller child provisions returned whole or cut (its full size, and the links to the full text), and how to continue."
changedOutput schema / properties / unapplied_effects / description
Previous value: -"Recorded effects not yet applied to the revised text that touch this provision (at item level, the item’s): the first 20, outstanding first, with a notice when more exist; empty when none. Absent on an item-level outline, where a notice gives the item’s count and uklaw_get_amendments lists them."New value: +"Recorded effects not yet applied to the revised text that touch this provision — whole-item effects, those on an element enclosing it (Part, Chapter, cross-heading), and when kind is full those on a provision inside it — or at item level the item’s: the first 20, outstanding first, with a notice when more exist; empty when none. An outlined provision does not list the effects inside it; a notice counts them. Absent on an item-level outline, where a notice gives the item’s count. uklaw_get_amendments with the item (for a pre-1963 Act, its calendar-year path, as the notices name it) and status \"unapplied\", without provision, lists them all."