Update dependency ds-caselaw-marklogic-api-client to v17 #250
+230
−16
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
5.2.6
->17.0.0
Release Notes
nationalarchives/ds-caselaw-custom-api-client (ds-caselaw-marklogic-api-client)
v17.0.0
Compare Source
VersionAnnotation
now requires a statement of if the action is automated or notVersionAnnotation
can now accept an optional dict of structuredpayload
dataVersionAnnotation
can now record a user agent stringv16.0.0
Compare Source
insert_document_xml
can now be annotatedsave_judgment_xml
toupdate_document_xml
VersionAnnotation
classv15.1.2
Compare Source
v15.1.1
Compare Source
v15.1.0
Compare Source
v15.0.1
Compare Source
v15.0.0
Compare Source
Changed
is_failure
to rely onfailed_to_parse
, rather thanfailure
in the URI.Added
transformation_datetime
toDocument
Added
enrichment_datetime
toDocument
Added
get_manifestation_datetimes
toDocument
Added
get_latest_manifestation_datetime
toDocument
Added
versions_as_documents
toDocument
Added
is_version
toDocument
Added
version_number
toDocument
v14.1.0
Compare Source
v14.0.2
Compare Source
neutral_citation
property to look withinpreface
tag rather thanmainBody
for press summaries, due to updated parsing resulting in updated press summary xml structure.python-dotenv
as a poetrydev
dependency to be able to run the newsmoketest.py
file that connects to a MarkLogic instance.v14.0.1
Compare Source
Client.set_document_court
methodClient.get_document_type_from_uri
methodv14.0.0
Compare Source
document.is_editable
in favour of the more descriptive and better-testeddocument.failed_to_parse
.Document.delete()
method.v13.2.1
Compare Source
v13.1.0
Compare Source
get_judgment_xml_bytestring
andcontent_as_xml_bytestring
toClient
content_as_xml_tree
by making it usecontent_as_xml_bytestring
Document
class'name
,court
,document_date_as_string
anddocument_date_as_date
work for Press Summaries also.neutral_citation
property and validation toPressSummary
class.caselawclient.api_client
instance should be considered deprecated. Projects should instead initialise their own instance.v13.0.0
Compare Source
Breaking changes
supplemental/anonymous/sensitive getters/setters removed
XQueries which return multiple responses will raise an error
Refactored
Document
class'name
,court
,document_date_as_string
anddocument_date_as_date
(previously judgment_date_...) on Document class and neutral_citation on Judgment class making use of the new cachedcontent_as_xml_tree
property.Renamed
judgment_date_as_string
judgment_date_as_date
todocument_date_as_string
anddocument_date_as_date
respectively.Added
content_as_xml_tree
cached property toDocument
classChanged the
Document
class'content_as_xml
to be a cached_property also. [Note: this changelog line previously mistakenly referred tocontent_as_html
.]Removed
get_judgment_name
,get_judgment_citation
,get_judgment_court
,get_judgment_work_date
from theClient
class and associated.xqy
files.Add a new
MarklogicApiClient.get_document_by_uri
method to retrieve a document (of any type) by URI.New
get_document_by_uri
method on API client returning unique types forJudgment
s andPressSummary
s.New
Document.enrich()
method to trigger enrichmentv12.0.0
Compare Source
Judgment
toDocument
Document.judgment_exists
is nowDocument.document_exists
v11.0.1
Compare Source
v11.0.0
Compare Source
copy_judgment
tocopy_document
copy_document
now adds the document to the appropriate collection based on the uri.v10.1.0
Compare Source
Judgment.validation_failure_messages
method for retrieving a list of strings with reasons a judgment cannot be published.v10.0.1
Compare Source
insert_document_xml
to pattern match uris with and add documents topress-summary
, notpress_summary
.v10.0.0
Compare Source
insert_judgment_xml
toinsert_document_xml
and enhanced it to place a document in the appropriate collection (press_summary
orjudgment
)v9.0.0
Compare Source
SearchParameters
dataclass field fromq
toquery
search_helpers
module to allow clients to search and process document search responses in one go.v8.0.0
Compare Source
SearchParameters
dataclass for use with search functions using the legacy kwargs fromClient.advanced_search
and newcollections
field for filtering by collectionsClient.advanced_search
interface to take inSearchParameters
as opposed to the legacy kwargs.search_and_decode_response
andsearch_judgments_and_decode_response
methods toClient
SearchResponse
,SearchResult
,SearchResultMetadata
classes to encapsulate and process document search responses.v7.0.0
Compare Source
VersionAnnotation
now requires a statement of if the action is automated or notVersionAnnotation
can now accept an optional dict of structuredpayload
dataVersionAnnotation
can now record a user agent stringv6.1.0
Compare Source
Judgment.publish
method will now reject publication in more invalid states (must have a name, must have a valid NCN, must have a court code).v6.0.0
Compare Source
insert_document_xml
can now be annotatedsave_judgment_xml
toupdate_document_xml
VersionAnnotation
classv5.3.2
Compare Source
v5.3.1
Compare Source
v5.3.0
Compare Source
Judgment
class (copied from Editor Interface) to begin the process of harmonising how various services interface with the dataConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - "after 10am every weekday,before 4pm every weekday" in timezone Europe/London.
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.