docs(api): Updates API changlog #4745
Open
+26
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ERosendo
force-pushed
the
4678-update-rest-api-changlog
branch
from
1bf2a05
to
cb0280e
Compare
mlissner
requested changes
Nov 27, 2024
There was a problem hiding this comment.
I think we can do a bit more here:
- Include links to the PRs and issues.
- Update the API pages to say v4.1 instead of v4.0.
- Link to the documentation for each feature from the release notes.
I think it's also worth separating the many enhancements into a bulleted list or something. It's a bit tricky to realize that the various sentences are orthogonal to each other.
|
@mlissner I've applied your suggestions, and here's the updated v4.1 section:
|
mlissner
approved these changes
Nov 29, 2024
There was a problem hiding this comment.
Looks close.
The ordering comment isn't quite right though. The order_by parameter wasn't added, just additional fields to use with it:
A couple little tweaks too. It's important to get this right so that we can advertise all the little enhancements.
Thank you!
| (<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 filter_nested_results=True query parameter. This enables granular filtering of nested data, providing more control over the retrieved information. |
There was a problem hiding this comment.
Suggested change
| <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 filter_nested_results=True query parameter. This enables granular filtering of nested data, providing more control over the retrieved information. | |
| <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. |
| @@ -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 – v4.0</h1> | |||
| <h1 id="about">REST API – v4.1</h1> | |||
There was a problem hiding this comment.
Let's catch this in the HTML title too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #4678 by updating the REST API changelog template to reflect all changes made during the recent sprint cycle.
Note: This PR should be merged once all sub-issues related to #4678 are resolved.