Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api v4 edits #4483

Merged
merged 13 commits into from
Sep 22, 2024
2 changes: 1 addition & 1 deletion cl/api/templates/case-law-api-docs-vlatest.html
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ <h3 id="filtering-court">Filtering to Opinions in a Court</h3>
"{% get_full_host %}{% url "opinion-list" version=version %}?cluster__docket__court=scotus"</pre>
<p>That returns:</p>
<pre class="pre-scrollable">{
"next": "https://www.courtlistener.com/api/rest/{{ version }}/opinions/?cluster__docket__court=scotus&page=2",
"next": "https://www.courtlistener.com/api/rest/{{ version }}/opinions/?cluster__docket__court=scotus&cursor=cD0xMDUxNjI5NA%3D%3D",
"previous": null,
"results": [
{
Expand Down
2 changes: 1 addition & 1 deletion cl/api/templates/citation-api-docs-vlatest.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h2 id="cites-endpoint">Opinions Cited/Citing API<br><small><code>{% url "opinio
<p>Which returns (in part):</p>
<pre class="pre-scrollable tall">{
"count": 75,
"next": "https://www.courtlistener.com/api/rest/{{ version }}/opinions-cited/?citing_opinion=2812209&page=2",
"next": "https://www.courtlistener.com/api/rest/{{ version }}/opinions-cited/?citing_opinion=2812209&cursor=cD0xMjA5NjAyMg%3D%3D",
"previous": null,
"results": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h3 id="redactions">Redactions</h3>
<pre class="pre-scrollable tall">curl "{% get_full_host %}{% url "investment-list" version=version %}?redacted=True" \
--header 'Authorization: Token {% if user.is_authenticated %}{{ user.auth_token }}{% else %}&lt;your-token-here&gt;{% endif %}'
{
"next": "https://www.courtlistener.com/api/rest/{{ version }}/investments/?page=2&redacted=True",
"next": "https://www.courtlistener.com/api/rest/{{ version }}/investments/?page=2&redacted=True&cursor=cD0xMjA5NjAyMg%3D%3D",
"previous": null,
"results": [
{
Expand Down
130 changes: 51 additions & 79 deletions cl/api/templates/includes/toc_migration_guide_sidebar.html
Original file line number Diff line number Diff line change
@@ -1,83 +1,55 @@
<div id="toc">
<h3>Table of Contents</h3>
<ul>
<li><a href="#whats-happening">What's Happening?</a></li>
<li><a href="#timeline-changes">Timeline for Changes</a></li>
<li><a href="#what-if-do-nothing">What If I Do Nothing?</a></li>
<li><a href="#what-to-expect">What New Features Can I Expect?</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseWhatToExpect" role="button"
aria-expanded="false" aria-controls="collapseWhatToExpect">
[+]
</a>
</li>
<ul class="collapse" id="collapseWhatToExpect">
<li><a href="#cursor-pagination">Cursor-based pagination</a></li>
<li><a href="#elasticsearch">ElasticSearch</a></li>
</ul>
<li><a href="#breaking-changes">Breaking Changes to v3 of the Search API</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseV3Breaking" role="button"
aria-expanded="false" aria-controls="collapseV3Breaking">
[+]
</a>
</li>
<ul class="collapse" id="collapseV3Breaking">
<li><a href="#recap-breaking-changes">RECAP (type=r)</a></li>
<li><a href="#opinions-breaking-changes">Opinions (type=o)</a></li>
<li><a href="#oa-breaking-changes">Oral Arguments (type=oa)</a></li>
<li><a href="#people-breaking-changes">People</a></li>
</ul>
<li><a href="#migrate-db-apis">How Do I Migrate Database APIs?</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseMigrateDBAPIS" role="button"
aria-expanded="false" aria-controls="collapseMigrateDBAPIS">
[+]
</a>
</li>
<ul class="collapse" id="collapseMigrateDBAPIS">
<li><a href="#total-count-results">Total count of results</a></li>
<li><a href="#invalid-cursor">Invalid cursor error code: 404</a></li>
<h3>Table of Contents</h3>
<ul>
<li><a href="#overview">Top</a></li>
<li><a href="#support">Support</a></li>
<li><a href="#timeline-changes">Timeline</a></li>
<li><a href="#what-if-do-nothing">Can I Do Nothing?</a></li>
<li><a href="#what-to-expect">New Features</a>
</li>
<ul id="collapseWhatToExpect">
<li><a href="#cursor-pagination">Deep Pagination</a></li>
<li><a href="#elasticsearch">Enhanced Search</a></li>
</ul>
<li><a href="#breaking-changes">Breaking Changes to v3</a></li>
<ul id="collapseV3Breaking">
<li><a href="#recap-breaking-changes">RECAP (type=r)</a></li>
<li><a href="#opinions-breaking-changes">Opinions (type=o)</a></li>
<li><a href="#oa-breaking-changes">Oral Arguments (type=oa)</a></li>
<li><a href="#people-breaking-changes">People (type=p)</a></li>
</ul>
<li><a href="#migrate-db-apis">Migrate Database APIs</a></li>
<ul id="collapseMigrateDBAPIS">
<li><a href="#total-count-results">Result counts</a></li>
<li><a href="#invalid-cursor">Invalid cursors</a></li>
</ul>
<li><a href="#migrate-search-apis">Migrate the Search API?</a></li>
<ul id="collapseMigrateSearchAPIS">
<li><a href="#enhancements-v4">Enhancements</a></li>
<ul id="collapseEnhancementsV4">
<li><a href="#enhancements-cursor-pagination">Deep Pagination</a></li>
<li><a href="#enhancements-results-sorting">Better Ordering</a></li>
<li><a href="#enhancements-highlighting">Highlighting</a></li>
<li><a href="#enhancements-empty-fields">Empty fields</a></li>
</ul>
<li><a href="#migrate-search-apis">How Do I Migrate the Search API?</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseMigrateSearchAPIS" role="button"
aria-expanded="false" aria-controls="collapseMigrateSearchAPIS">
[+]
</a>
</li>
<ul class="collapse" id="collapseMigrateSearchAPIS">
<li><a href="#enhancements-v4">Enhancements in v4</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseEnhancementsV4" role="button"
aria-expanded="false" aria-controls="collapseEnhancementsV4">
[+]
</a>
</li>
<ul class="collapse" id="collapseEnhancementsV4">
<li><a href="#enhancements-cursor-pagination">Search API crawls are no longer limited to 100 pages</a></li>
<li><a href="#enhancements-results-sorting">Result sorting is more consistent</a></li>
<li><a href="#enhancements-highlighting">Highlighting is more consistent</a></li>
<li><a href="#enhancements-empty-fields">Empty fields are standardized</a></li>
</ul>
<li><a href="#v4-backwards-incompatible-changes">Backwards incompatible changes in v4</a>
<a class="collapse-header" data-toggle="collapse" href="#collapseIncompatibleChangesV4" role="button"
aria-expanded="false" aria-controls="collapseIncompatibleChangesV4">
[+]
</a>
</li>
<ul class="collapse" id="collapseIncompatibleChangesV4">
<li><a href="#backwards-estimated-counts">High query counts are estimated</a></li>
<li><a href="#backwards-highlighting">Highlighting</a></li>
<li><a href="#backwards-nested-keys">Nested keys (documents) for type=o and type=p</a></li>
<li><a href="#backwards-type-r">type=r is now for dockets with nested documents</a></li>
<li><a href="#backwards-type-rd">type=rd is a new result type for documents</a></li>
<li><a href="#backwards-type-d">type=d still returns dockets</a></li>
<li><a href="#backwards-removed-fields">Removed fields</a></li>
<li><a href="#backwards-changed-fields">Changed field values</a></li>
<li><a href="#backwards-date-times">Dates and times</a></li>
<li><a href="#backwards-no-random-sorting">No more random sorting</a></li>
<li><a href="#backwards-stemming-synonyms">Stemming and Synonyms</a></li>
<li><a href="#backwards-get-params">Changes to GET parameters</a></li>
<li><a href="#backwards-400-error">Bad Request Error Code: 400</a></li>
<li><a href="#backwards-500-error">Server Error Code: 500</a></li>
<li><a href="#backwards-404-error">Not Found Error Code: 404</a></li>
</ul>
<li><a href="#v4-backwards-incompatible-changes">Incompatibilities</a></li>
<ul id="collapseIncompatibleChangesV4">
<li><a href="#backwards-estimated-counts">Query counts</a></li>
<li><a href="#backwards-highlighting">Highlighting</a></li>
<li><a href="#backwards-nested-keys">Nested Keys</a></li>
<li><a href="#backwards-type-r">Nested Docket Search</a></li>
<li><a href="#backwards-type-rd">Document Search</a></li>
<li><a href="#backwards-type-d">Docket Search</a></li>
<li><a href="#backwards-removed-fields">Removed Fields</a></li>
<li><a href="#backwards-changed-fields">Changed Field Values</a></li>
<li><a href="#backwards-date-times">Dates and Times</a></li>
<li><a href="#backwards-no-random-sorting">Random Sorting</a></li>
<li><a href="#backwards-stemming-synonyms">Stemming and Synonyms</a></li>
<li><a href="#backwards-get-params">Changes to GET parameters</a></li>
<li><a href="#backwards-400-error">Error Code: 400</a></li>
<li><a href="#backwards-500-error">Error Code: 500</a></li>
<li><a href="#backwards-404-error">Error Code: 404</a></li>
</ul>
</ul>
</div>
</ul>
</div>
1 change: 1 addition & 0 deletions cl/api/templates/includes/toc_sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ <h3><span>Table of Contents</span></h3>
<li><a href="#filtering">Filtering</a></li>
<li><a href="#ordering">Ordering</a></li>
<li><a href="#field-selection">Field Selection</a></li>
<li><a href="#pagination">Pagination</a></li>
<li><a href="#rates">Rate Limits</a></li>
<li><a href="#performance-tips">Performance Tips</a></li>
<li><a href="#field-details">Field Definitions</a></li>
Expand Down
8 changes: 4 additions & 4 deletions cl/api/templates/jurisdictions.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% extends "base.html" %}
{% load text_filters %}
{% load text_filters humanize %}

{% block title %}Available Jurisdictions – CourtListener.com{% endblock %}
{% block description %} A list of the hundreds of jurisdictions available on CourtListener.{% endblock %}
Expand All @@ -11,12 +11,12 @@
<h2>Available Jurisdictions</h2>

<p>
We currently have <span id="jurisdiction-count">{{ courts.count }}</span> jurisdictions available on CourtListener. These jurisdictions are available via
We currently have <span id="jurisdiction-count">{{ courts.count|intcomma }}</span> jurisdictions available on CourtListener. These jurisdictions are available via
our API or can be used in our bulk data queries.
</p>

<p>
Some of the data below is incomplete, missing dates or other information. If you are a legal researcher
Some data below is incomplete, missing dates or other information. If you are a legal researcher
interested in helping us research this or other data, please get in touch via our <a href="{% url "contact" %}">contact
form</a>. We welcome your contribution.
</p>
Expand Down Expand Up @@ -52,7 +52,7 @@ <h2>Available Jurisdictions</h2>
{% for court in courts %}
<tr>
<td>{{ court.full_name }}</td>
<td>{{ court.count }}</td>
<td>{{ court.count|intcomma }}</td>
<td>{{ court.get_jurisdiction_display|nbsp }}</td>
<td title="{{ court.url }}">
<a href="{{ court.url }}" target="_blank">
Expand Down
Loading
Loading