Skip to content

feat(help_pages): implement new design of REST-DOCS API help page #5937

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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
+532 −0
Draft

feat(help_pages): implement new design of REST-DOCS API help page #5937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3df66b2
style(warning): update warning component and Tailwind styles
Jun 30, 2025
666c800
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 30, 2025
783c0e9
feat(help): update design of v2 REST API docs page
nazarbodak221 Jul 10, 2025
e627871
feat(help): add comment about new template version
nazarbodak221 Jul 10, 2025
2e3b0cb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 17, 2025
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
13 changes: 13 additions & 0 deletions cl/api/templates/rest-docs-v3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@
{% load static %}
{% load extras %}

{% comment %}
╔═════════════════════════════════════════════════════════════════════════╗
║ ATTENTION! ║
║ This template has a new version behind the use_new_design waffle flag. ║
║ ║
║ When modifying this template, please also update the new version at: ║
║ cl/simple_pages/templates/v2_help/rest-docs-vlatest.html ║
║ ║
║ Once the new design is fully implemented, all legacy templates ║
║ (including this one) and the waffle flag will be removed. ║
╚═════════════════════════════════════════════════════════════════════════╝
{% endcomment %}

{% block title %}[Deprecated] REST API, v3.15 – CourtListener.com{% endblock %}
{% block description %}Deprecated — 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 %}
Expand Down
7 changes: 7 additions & 0 deletions cl/api/templates/v2_includes/v3-deprecated-warning.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div class="alert alert-danger ">
<p class="bottom">These notes are for a version of the API that is deprecated.
New implementations should use the <a href="{% url "rest_docs" %}">latest version of the API</a>
and existing software <a href="{% url "migration_guide" %}">should be upgraded</a>.
These notes are maintained to help with migrations.
</p>
</div>
Loading