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.

Sign up for GitHub

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

Jump to bottom

docs(api): Updates API changlog #4745

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+26 −1
Open

docs(api): Updates API changlog #4745

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb0280e
docs(api): Updates API changlog
ERosendo Nov 27, 2024
5d22130
Merge branch 'main' into 4678-update-rest-api-changlog
ERosendo Nov 27, 2024
1d7d0cd
docs(api): Update the API page
ERosendo Nov 27, 2024
f1b6674
docs(API): Improve v4.1 documentation with bulleted list
ERosendo Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions cl/api/templates/rest-change-log.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ <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 version adds new <code>count=on</code> 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 <strong>score</strong> values to the payload.</p>
<p>The docket entry endpoint now supports flexible result sorting through the <code>order_by</code> query parameter. For more precise filtering, the parties and attorneys endpoint has been enhanced with the <code>filter_nested_results=True</code> query parameter. Finally, the court endpoint now allows filtering of results based on parent court relationships using the <code>parent_court</code> query parameter.</p>
</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>
Expand Down