Skip to content

Commit 51bb0f9

Browse files
committed
docs(api): move around attribute comments
1 parent 84a0359 commit 51bb0f9

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

openapi.yaml

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,35 +1688,8 @@ components:
16881688
items:
16891689
$ref: '#/components/schemas/EnrichmentResult'
16901690
type: array
1691-
description: 'The input documents enriched into version 1.0.0 of the Isaacus
1692-
Legal Graph Schema (IGLS).
1693-
1694-
1695-
All spans in an enriched document graph are indexed into the Unicode code
1696-
point space of a source document. Access to source documents is thus required
1697-
to resolve spans into text.
1698-
1699-
1700-
The start and end indices of spans are zero-based (i.e., the first Unicode
1701-
code point in the document is at index 0) and half-open (i.e., the end
1702-
index is exclusive).
1703-
1704-
1705-
All spans are globally laminar and well-nested similar to XML—it is impossible
1706-
for any two spans to partially overlap; they can only be disjoint, adjacent,
1707-
or wholly nested.
1708-
1709-
1710-
Spans of the exact same type (e.g., segments) will never be duplicated.
1711-
1712-
1713-
Spans cannot be empty and will never start or end at whitespace.
1714-
1715-
1716-
When using programming languages other than Python (which uses zero-based,
1717-
half-open, Unicode code point-spaced string indexing), indices may need
1718-
to be translated accordingly (for example, JavaScript slices into UTF-16
1719-
code units instead of Unicode code points).'
1691+
description: The enriched documents alongside, and in order of, their indices
1692+
in the input array of texts.
17201693
examples:
17211694
- version: ilgs@1
17221695
text: '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the
@@ -3847,8 +3820,34 @@ components:
38473820
- junk
38483821
- version
38493822
title: ILGSv1 Document
3850-
description: The document enriched into version 1.0.0 of the Isaacus Legal Graph
3851-
Schema (ILGS).
3823+
description: 'The document enriched into version 1.0.0 of the Isaacus Legal
3824+
Graph Schema (IGLS).
3825+
3826+
3827+
All spans in an enriched document graph are indexed into the Unicode code
3828+
point space of a source document.
3829+
3830+
3831+
The start and end indices of spans are zero-based (i.e., the first Unicode
3832+
code point in the document is at index 0) and half-open (i.e., the end index
3833+
is exclusive).
3834+
3835+
3836+
All spans are globally laminar and well-nested similar to XML—it is impossible
3837+
for any two spans to partially overlap; they can only be disjoint, adjacent,
3838+
or wholly nested.
3839+
3840+
3841+
Spans of the exact same type (e.g., segments) will never be duplicated.
3842+
3843+
3844+
Spans cannot be empty and will never start or end at whitespace.
3845+
3846+
3847+
When using programming languages other than Python (which uses zero-based,
3848+
half-open, Unicode code point-spaced string indexing), indices may need to
3849+
be translated accordingly (for example, JavaScript slices into UTF-16 code
3850+
units instead of Unicode code points).'
38523851
examples:
38533852
- version: ilgs@1
38543853
text: '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing

0 commit comments

Comments
 (0)