Skip to content

Commit

Permalink
Merge pull request freelawproject#3793 from freelawproject/typo-rest-…
Browse files Browse the repository at this point in the history
…docs

docs(rest-docs): Typo
  • Loading branch information
mlissner authored Feb 15, 2024
2 parents 816be55 + 4175c8a commit 6a3e104
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion cl/api/templates/rest-docs-vlatest.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h2 id="data-modeling">Data Modeling</h2>
</li>
<li><code>Opinion Clusters</code> are collections of <code>Opinion</code> objects. <code>Opinions</code> can be Dissents, Concurrences or other types of opinion, and so this is how they are grouped together for a specific case. If we don't know if an <code>Opinion</code> is a Dissent, Concurrence or something else, we just call it a Combined Opinion. You can see all the different types of Opinions by sending an <code>OPTIONS</code> request to the <code>Opinion</code> endpoint.
</li>
<li><code>Docket Entries</code> are the individual rows of data on a PACER docket. In PACER some rows on the docket refer to several files, and so <code>Docket Entries</code> contain <code>RECAP Document</code> objects to represent those sub-resources. Thus, the big picture is, <code>Dockets</code> contain <code>Docket Entries</code>. <code>Docket Entires</code> contain <code>RECAP Documents</code>.
<li><code>Docket Entries</code> are the individual rows of data on a PACER docket. In PACER some rows on the docket refer to several files, and so <code>Docket Entries</code> contain <code>RECAP Document</code> objects to represent those sub-resources. Thus, the big picture is, <code>Dockets</code> contain <code>Docket Entries</code>. <code>Docket Entries</code> contain <code>RECAP Documents</code>.
</li>
<li>As a general rule, metadata lives at the highest level where it makes sense. For example, it's possible to put docket numbers in the <code>Opinion Cluster</code> objects, but it makes more sense at a higher level&mdash;at the <code>Docket</code> level. A sometimes-confusing counter example are case names, which have metadata at the <code>Docket</code> level <em>and</em> at the <code>Opinion Cluster</code> level. This is because case names can change at different times, and because a single <code>Docket</code> could have multiple <code>Opinion Clusters</code>, each with a different case name. <a href="#case-names">See more information about case names.</a>
</li>
Expand Down

0 comments on commit 6a3e104

Please sign in to comment.