Skip to content

Commit

Permalink
fix(docs): Updated documentation with suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
albertisfu committed Jan 3, 2025
1 parent 7139689 commit fffbfad
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion cl/api/templates/search-api-docs-vlatest.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ <h3 id="type">Setting the Result <code>type</code></h3>
<tbody>
<tr>
<td><code>o</code></td>
<td>Case law opinions</td>
<td>Case law opinion clusters with nested Opinion documents.</td>
</tr>
<tr>
<td><code>r</code></td>
Expand Down
8 changes: 4 additions & 4 deletions cl/api/templates/webhooks-docs-vlatest.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{% extends "base.html" %}
{% load static %}
{% load extras %}
{% load waffle_tags %}

{% block title %}Webhook API &ndash; CourtListener.com{% endblock %}
{% block description %}
Expand Down Expand Up @@ -421,11 +422,10 @@ <h2 id="change-log">Change Log</h2>
</li>
<li>
<p><strong>v2</strong> - This release introduces support for Case Law Search Alerts results with nested documents.</p>
<p>You can now select the webhook version when configuring an endpoint. For most event types, there are no differences between <code>v1</code> and <code>v2</code>, as the payload remains unchanged.
<p>You can now select the webhook version when configuring an endpoint. For most webhook event types, there are no differences between <code>v1</code> and <code>v2</code>, as the payload remains unchanged.
</p>
<p>However, for the Search Alert event type, the <code>v2</code> payload now includes results with nested documents for search types that support it, such as Case Law. If you select <code>v1</code>, the payload remains unchanged from the previous version.
</p>
<p>For other search types, such as Oral Arguments, the payload in <code>v2</code> is identical to that in <code>v1</code>.</p>
<p>In the Search Alert webhook event type, the Oral Arguments search response remains identical between <code>v1</code> and <code>v2</code>.</p>
<p>For Case Law {% flag "recap-alerts-active" %}and RECAP{% endflag %} <code>v2</code> now includes nested results, which are based on the new changes introduced in <code>v4</code> of the <a href="{% url "search_api_help" version="v4" %}">Search API.</a></p>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion cl/api/templates/webhooks-getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ <h2 id="setup-a-webhook">Set Up a Webhook Endpoint in CourtListener</h2>
</li>
<li>
<p>Choose the webhook version you wish to set up.</p>
<p>Refer to the <a href="{% url "webhooks_docs" version="v2" %}#change-log">Change Log</a> for more details on webhook versions.</p>
<p>We recommend selecting the highest available version for your webhook. Refer to the <a href="{% url "webhooks_docs" version="v2" %}#change-log">Change Log</a> for more details on webhook versions.</p>
<p>You can only create one Webhook endpoint for each type of event and version. Please get in touch if this limitation causes difficulty for your application.
</p>
</li>
Expand Down

0 comments on commit fffbfad

Please sign in to comment.