Merge pull request #4745 from freelawproject/4678-update-rest-api-cha…

…nglog

docs(api): Updates API changlog

cl/api/templates/rest-change-log.html

@@ -30,6 +30,31 @@ <h4 class="v-offset-below-3">
 <div class="col-xs-12 col-md-8 col-lg-6">
   <h1 id="about">REST API Change Log</h1>
   <ul>
+    <li>
+      <p><strong>v4.1</strong>&mdash; This release introduces a number of enhancements aimed at improving the efficiency and flexibility of your data retrieval.</p>
+      <ul>
+        <li><strong>Enhanced Paginated Endpoints:</strong> Introduced the <a href="{% url "rest_docs" %}#counting">count=on</a> query parameter to efficiently retrieve total item counts without fetching actual data
+          (<a href="https://github.com/freelawproject/courtlistener/issues/4506">Issue #4506</a>, <a
+            href="https://github.com/freelawproject/courtlistener/pull/4715">PR #4715</a>).
+        </li>
+        <li><strong>Search Results:</strong> Improved search results across all search types by incorporating <a href="{% url "search_api_help" %}#notes">score values</a> to the payload
+          (<a href="https://github.com/freelawproject/courtlistener/issues/4312">Issue #4312</a>, <a
+            href="https://github.com/freelawproject/courtlistener/pull/4712">PR #4712</a>).
+        </li>
+        <li><strong>Flexible Docket Entry Sorting:</strong> The <a href="{% url "pacer_api_help" %}#docket-entry-endpoint">Docket Entry endpoint</a> now supports sorting results by <code>recap_sequence_number</code> and <code>entry_number</code>.  This added flexibility allows you to customize your data retrieval to meet specific requirements.
+          (<a href="https://github.com/freelawproject/courtlistener/issues/4061">Issue #4061</a>, <a
+            href="https://github.com/freelawproject/courtlistener/pull/4700">PR #4700</a>).
+        </li>
+        <li><strong>Deeper Filtering for Parties and Attorneys:</strong> The <a href="{% url "pacer_api_help" %}#party-endpoint">parties</a> and <a href="{% url "pacer_api_help" %}#attorney-endpoint">attorneys</a> API endpoint has been upgraded with the <code>filter_nested_results=True</code> query parameter. This enables granular filtering of nested data, providing more control over the retrieved information.
+          (<a href="https://github.com/freelawproject/courtlistener/issues/4054">Issue #4054</a>, <a
+            href="https://github.com/freelawproject/courtlistener/pull/4729">PR #4729</a>).
+        </li>
+        <li><strong>Enhanced Court Filtering:</strong> The <code>parent_court</code> query parameter has been added to the <a href="{% url "pacer_api_help" %}#court-endpoint">Court endpoint</a>, allowing you to filter results based on parent-child relationships between courts.
+          (<a href="https://github.com/freelawproject/courtlistener/issues/4711">Issue #4711</a>, <a
+            href="https://github.com/freelawproject/courtlistener/pull/4744">PR #4744</a>).
+        </li>
+      </ul>
+    </li>
     <li>
       <p><strong>v4.0</strong> — Migrate search to ElasticSearch and enable cursor-based pagination. See the <a href="{% url "migration_guide" %}">Migration Guide</a> for details.</p>
     </li>

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 %}
 
@@ -24,7 +24,7 @@ <h4 class="v-offset-below-2">
     {% include "includes/toc_sidebar.html" %}
   </div>
   <div class="col-xs-12 col-md-8 col-lg-6">
-    <h1 id="about">REST API &ndash; v4.0</h1>
+    <h1 id="about">REST API &ndash; v4.1</h1>
 
     <p class="lead">APIs for developers and researchers that need granular legal data.
     </p>