From cb0280eefead1780c72a6700071df4c602188699 Mon Sep 17 00:00:00 2001 From: Eduardo Rosendo Date: Wed, 27 Nov 2024 01:06:29 -0400 Subject: [PATCH 1/5] docs(api): Updates API changlog --- cl/api/templates/rest-change-log.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cl/api/templates/rest-change-log.html b/cl/api/templates/rest-change-log.html index 7d735a675f..2083bf5ad5 100644 --- a/cl/api/templates/rest-change-log.html +++ b/cl/api/templates/rest-change-log.html @@ -30,6 +30,10 @@

REST API Change Log

    +
  • +

    v4.1— This version adds new count=on query parameter to paginated endpoints, allowing for efficient retrieval of total item counts without fetching actual data. Additionally, search results across all search types have been improved by incorporating score values to the payload.

    +

    The docket entry endpoint now supports flexible result sorting through the order_by query parameter. For more precise filtering, the parties and attorneys endpoint has been enhanced with the filter_nested_results=True query parameter. Finally, the court endpoint now allows filtering of results based on parent court relationships using the parent_court query parameter.

    +

  • v4.0 — Migrate search to ElasticSearch and enable cursor-based pagination. See the Migration Guide for details.

    • From 1d7d0cde592d19eed362f756403db5525c05f05b Mon Sep 17 00:00:00 2001 From: Eduardo Rosendo Date: Wed, 27 Nov 2024 17:36:37 -0400 Subject: [PATCH 2/5] docs(api): Update the API page --- cl/api/templates/rest-docs-vlatest.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cl/api/templates/rest-docs-vlatest.html b/cl/api/templates/rest-docs-vlatest.html index 91e7205bcd..4d6f367ae3 100644 --- a/cl/api/templates/rest-docs-vlatest.html +++ b/cl/api/templates/rest-docs-vlatest.html @@ -24,7 +24,7 @@

    {% include "includes/toc_sidebar.html" %}

-

REST API – v4.0

+

REST API – v4.1

APIs for developers and researchers that need granular legal data.

From f1b667443aa477364f650c1e7a752532e6a47911 Mon Sep 17 00:00:00 2001 From: Eduardo Rosendo Date: Wed, 27 Nov 2024 22:00:47 -0400 Subject: [PATCH 3/5] docs(API): Improve v4.1 documentation with bulleted list --- cl/api/templates/rest-change-log.html | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/cl/api/templates/rest-change-log.html b/cl/api/templates/rest-change-log.html index 2083bf5ad5..f2c2e623a7 100644 --- a/cl/api/templates/rest-change-log.html +++ b/cl/api/templates/rest-change-log.html @@ -31,8 +31,29 @@

REST API Change Log

  • -

    v4.1— This version adds new count=on query parameter to paginated endpoints, allowing for efficient retrieval of total item counts without fetching actual data. Additionally, search results across all search types have been improved by incorporating score values to the payload.

    -

    The docket entry endpoint now supports flexible result sorting through the order_by query parameter. For more precise filtering, the parties and attorneys endpoint has been enhanced with the filter_nested_results=True query parameter. Finally, the court endpoint now allows filtering of results based on parent court relationships using the parent_court query parameter.

    +

    v4.1— This release introduces a number of enhancements aimed at improving the efficiency and flexibility of your data retrieval.

    +
      +
    • Enhanced Paginated Endpoints: Introduced the count=on query parameter to efficiently retrieve total item counts without fetching actual data + (Issue #4506, PR #4715). +
      • +
    • Search Results: Improved search results across all search types by incorporating score values to the payload + (Issue #4312, PR #4712). +
      • +
    • Flexible Docket Entry Sorting: The order_by query parameter has been added to the Docket Entry endpoint, enabling you to sort results based on various fields. + (Issue #4061, PR #4700). +
      • +
    • Deeper Filtering for Parties and Attorneys: The parties and attorneys API endpoint has been upgraded with the filter_nested_results=True query parameter. This enables granular filtering of nested data, providing more control over the retrieved information. + (Issue #4054, PR #4729). +
      • +
    • Enhanced Court Filtering: The parent_court query parameter has been added to the Court endpoint, allowing you to filter results based on parent-child relationships between courts. + (Issue #4711, PR #4744). +
      • +

  • v4.0 — Migrate search to ElasticSearch and enable cursor-based pagination. See the Migration Guide for details.

    From 17d12064c3ccd9b67688685de3bbff79b7fdc9b6 Mon Sep 17 00:00:00 2001 From: Eduardo Rosendo Date: Sat, 30 Nov 2024 11:58:35 -0400 Subject: [PATCH 4/5] docs(api): Updates title of the API reference page --- cl/api/templates/rest-docs-vlatest.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cl/api/templates/rest-docs-vlatest.html b/cl/api/templates/rest-docs-vlatest.html index 4d6f367ae3..b59febecf9 100644 --- a/cl/api/templates/rest-docs-vlatest.html +++ b/cl/api/templates/rest-docs-vlatest.html @@ -1,7 +1,7 @@ {% extends "base.html" %} {% load static extras humanize %} -{% block title %}REST API, v4 – CourtListener.com{% endblock %} +{% block title %}REST API, v4.1 – CourtListener.com{% endblock %} {% block description %}REST API for federal and state case law, PACER data, the searchable RECAP Archive, oral argument recordings and more. Provided by Free Law Project, a 501(c)(3) non-profit. Please donate to support this service.{% endblock %} {% block og_description %}REST API for federal and state case law, PACER data, the searchable RECAP Archive, oral argument recordings and more. Provided by Free Law Project, a 501(c)(3) non-profit. Please donate to support this service.{% endblock %} From 9ae38cb55e5822557e03e602ea1e407b9e1e4db5 Mon Sep 17 00:00:00 2001 From: Eduardo Rosendo Date: Sat, 30 Nov 2024 12:10:02 -0400 Subject: [PATCH 5/5] docs(api): Refines v4.1 API changes --- cl/api/templates/rest-change-log.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cl/api/templates/rest-change-log.html b/cl/api/templates/rest-change-log.html index f2c2e623a7..015f914e22 100644 --- a/cl/api/templates/rest-change-log.html +++ b/cl/api/templates/rest-change-log.html @@ -41,11 +41,11 @@

    REST API Change Log

    (Issue #4312, PR #4712).
    • -
  • Flexible Docket Entry Sorting: The order_by query parameter has been added to the Docket Entry endpoint, enabling you to sort results based on various fields. +
  • Flexible Docket Entry Sorting: The Docket Entry endpoint now supports sorting results by recap_sequence_number and entry_number. This added flexibility allows you to customize your data retrieval to meet specific requirements. (Issue #4061, PR #4700).
    • -
  • Deeper Filtering for Parties and Attorneys: The parties and attorneys API endpoint has been upgraded with the filter_nested_results=True query parameter. This enables granular filtering of nested data, providing more control over the retrieved information. +
  • Deeper Filtering for Parties and Attorneys: The parties and attorneys API endpoint has been upgraded with the filter_nested_results=True query parameter. This enables granular filtering of nested data, providing more control over the retrieved information. (Issue #4054, PR #4729).