Skip to content

Commit 23e11ab

Browse files
krishnangovindrajkrishnangovindraj
authored
Align HTTP driver analyze type names with rust (#821)
## Usage and product changes Aligns HTTP driver analyze type names with rust. Any code using the driver will break. Major changes are: * QueryConstraint* is renamed to Constraint* * QueryVertex* is renamed to ConstraintVertex* The older names are preserved in `legacy.ts` but not exported to make updating to the new names easier. TypeDB 3.7.0 introduces a few minor breaking changes in the HTTP API. * Expression constraints now return a single variable instead of a list of variables. * The structure returned with a ConceptRowResponse has the `blocks` field renamed to `conjunctions` For applications which must operate with both versions before and after 3.7.0, certain types are exported with 'Legacy' as suffix.
1 parent e650c73 commit 23e11ab

File tree

68 files changed

+777
-500
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+777
-500
lines changed

‎dependencies/typedb/artifacts.bzl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def typedb_artifact():
2525
artifact_name = "typedb-all-{platform}-{version}.{ext}",
2626
tag_source = deployment["artifact"]["release"]["download"],
2727
commit_source = deployment["artifact"]["snapshot"]["download"],
28-
commit = "636ccfc5d9b15687627044128198b51bfb150fd4"
28+
commit = "6a8c8d80d20b5ba6d73c16350aa0d1b31dbe6a5e"
2929
)
3030

3131
#def typedb_cloud_artifact():

‎docs/modules/ROOT/partials/http-ts/analyze/AnalyzedConjunction.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#_AnalyzedConjunction]
2+
=== AnalyzedConjunction
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `annotations` a| `ConjunctionAnnotations` a|
12+
a| `constraints` a| `ConstraintAny` a|
13+
|===
14+
// end::properties[]
15+

‎docs/modules/ROOT/partials/http-ts/analyze/AnalyzedFetch.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[#_AnalyzedFetch]
2+
=== AnalyzedFetch
3+
4+
[source,typescript]
5+
----
6+
AnalyzedFetch:
7+
| { elements: AnalyzedFetch; tag: "list" }
8+
| { possibleFields: FetchAnnotationFieldEntry[]; tag: "object" }
9+
| { tag: "value"; valueTypes: ValueType[] }
10+
----
11+
12+

‎docs/modules/ROOT/partials/http-ts/analyze/AnalyzedFunction.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[#_AnalyzedFunction]
2+
=== AnalyzedFunction
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `argumentAnnotations` a| `VariableAnnotations` a|
12+
a| `arguments` a| `string` a|
13+
a| `body` a| `AnalyzedPipeline` a|
14+
a| `returnAnnotations` a| `VariableAnnotations` a|
15+
a| `returns` a| `FunctionReturnStructure` a|
16+
|===
17+
// end::properties[]
18+

‎docs/modules/ROOT/partials/http-ts/analyze/AnalyzedPipeline.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[#_AnalyzedPipeline]
2+
=== AnalyzedPipeline
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `conjunctions` a| `AnalyzedConjunction` a|
12+
a| `outputs` a| `string` a|
13+
a| `stages` a| `PipelineStage` a|
14+
a| `variables` a| `string` a|
15+
|===
16+
// end::properties[]
17+

‎docs/modules/ROOT/partials/http-ts/analyze/ConceptRowsQueryResponseLegacy.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[#_ConceptRowsQueryResponseLegacy]
2+
=== ConceptRowsQueryResponseLegacy
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `answerType` a| `"conceptRows"` a|
12+
a| `answers` a| `ConceptRowAnswer` a|
13+
a| `comment` a| `string` a|
14+
a| `query` a| `QueryStructureLegacy` a|
15+
a| `queryType` a| `QueryType` a|
16+
|===
17+
// end::properties[]
18+

‎docs/modules/ROOT/partials/http-ts/analyze/ConjunctionAnnotations.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[#_ConjunctionAnnotations]
2+
=== ConjunctionAnnotations
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `variableAnnotations` a| `string` a|
12+
|===
13+
// end::properties[]
14+

‎docs/modules/ROOT/partials/http-ts/analyze/ConstraintAny.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[#_ConstraintAny]
2+
==== ConstraintAny
3+
4+
[source,typescript]
5+
----
6+
ConstraintAny:
7+
| ConstraintIsa
8+
| ConstraintIsaExact
9+
| ConstraintHas
10+
| ConstraintLinks
11+
| ConstraintSub
12+
| ConstraintSubExact
13+
| ConstraintOwns
14+
| ConstraintRelates
15+
| ConstraintPlays
16+
| ConstraintExpression
17+
| ConstraintFunction
18+
| ConstraintComparison
19+
| ConstraintIs
20+
| ConstraintIid
21+
| ConstraintKind
22+
| ConstraintValue
23+
| ConstraintLabel
24+
| ConstraintOr
25+
| ConstraintNot
26+
| ConstraintTry
27+
----
28+
29+

docs/modules/ROOT/partials/http-ts/analyze/QueryConstraintComparison.adoc renamed to docs/modules/ROOT/partials/http-ts/analyze/ConstraintComparison.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[#_QueryConstraintComparison]
2-
==== QueryConstraintComparison
1+
[#_ConstraintComparison]
2+
==== ConstraintComparison
33
44
[caption=""]
55
.Fields
@@ -9,10 +9,10 @@
99
|===
1010
|Name |Type |Description
1111
a| `comparator` a| `string` a|
12-
a| `lhs` a| `QueryVertexVariable` a|
13-
a| `rhs` a| `QueryVertexVariable` a|
12+
a| `lhs` a| `ConstraintVertexVariable` a|
13+
a| `rhs` a| `ConstraintVertexVariable` a|
1414
a| `tag` a| `"comparison"` a|
15-
a| `textSpan` a| `QueryConstraintSpan` a|
15+
a| `textSpan` a| `ConstraintSpan` a|
1616
|===
1717
// end::properties[]
1818

‎docs/modules/ROOT/partials/http-ts/analyze/ConstraintExpression.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[#_ConstraintExpression]
2+
==== ConstraintExpression
3+
4+
[caption=""]
5+
.Fields
6+
// tag::properties[]
7+
[cols=",,"]
8+
[options="header"]
9+
|===
10+
|Name |Type |Description
11+
a| `arguments` a| `ConstraintVertexVariable` a|
12+
a| `assigned` a| `ConstraintVertexVariable` a|
13+
a| `tag` a| `"expression"` a|
14+
a| `text` a| `string` a|
15+
a| `textSpan` a| `ConstraintSpan` a|
16+
|===
17+
// end::properties[]
18+

0 commit comments

Comments
 (0)