-
-
Notifications
You must be signed in to change notification settings - Fork 150
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4483 from freelawproject/api-v4-edits
Api v4 edits
- Loading branch information
Showing
16 changed files
with
146 additions
and
211 deletions.
There are no files selected for viewing
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
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
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
130 changes: 51 additions & 79 deletions
130
cl/api/templates/includes/toc_migration_guide_sidebar.html
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
| 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> |
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
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
Oops, something went wrong.