@serviceai/api-spec 1.1.9 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/openapi.json +25 -3
- package/openapi.yaml +30 -18
- package/package.json +1 -1
- package/types.d.ts +8 -2
package/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "ServiceAi API",
|
|
5
|
-
"version": "1.1.
|
|
5
|
+
"version": "1.1.11",
|
|
6
6
|
"description": "Source-of-truth API contract for ServiceAi. Generated from `shared/schema.ts` Zod schemas by `scripts/build-api-spec.ts`. Versioning policy: see `docs/api-versioning.md`. The hand-written docs/ios-contract.md and docs/lidar-mobile-upload-contract.md are human-readable design notes only — this spec is the canonical wire contract.",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "Proprietary",
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
"properties": {
|
|
115
115
|
"apiVersion": {
|
|
116
116
|
"type": "string",
|
|
117
|
-
"example": "1.1.
|
|
117
|
+
"example": "1.1.11"
|
|
118
118
|
},
|
|
119
119
|
"minClientVersion": {
|
|
120
120
|
"type": "string",
|
|
@@ -1995,6 +1995,13 @@
|
|
|
1995
1995
|
"right",
|
|
1996
1996
|
"none"
|
|
1997
1997
|
]
|
|
1998
|
+
},
|
|
1999
|
+
"placementSource": {
|
|
2000
|
+
"type": "string",
|
|
2001
|
+
"enum": [
|
|
2002
|
+
"auto",
|
|
2003
|
+
"manual"
|
|
2004
|
+
]
|
|
1998
2005
|
}
|
|
1999
2006
|
},
|
|
2000
2007
|
"required": [
|
|
@@ -2054,6 +2061,13 @@
|
|
|
2054
2061
|
"right",
|
|
2055
2062
|
"none"
|
|
2056
2063
|
]
|
|
2064
|
+
},
|
|
2065
|
+
"placementSource": {
|
|
2066
|
+
"type": "string",
|
|
2067
|
+
"enum": [
|
|
2068
|
+
"auto",
|
|
2069
|
+
"manual"
|
|
2070
|
+
]
|
|
2057
2071
|
}
|
|
2058
2072
|
},
|
|
2059
2073
|
"required": [
|
|
@@ -2113,6 +2127,13 @@
|
|
|
2113
2127
|
"right",
|
|
2114
2128
|
"none"
|
|
2115
2129
|
]
|
|
2130
|
+
},
|
|
2131
|
+
"placementSource": {
|
|
2132
|
+
"type": "string",
|
|
2133
|
+
"enum": [
|
|
2134
|
+
"auto",
|
|
2135
|
+
"manual"
|
|
2136
|
+
]
|
|
2116
2137
|
}
|
|
2117
2138
|
},
|
|
2118
2139
|
"required": [
|
|
@@ -2251,7 +2272,8 @@
|
|
|
2251
2272
|
"type": "string",
|
|
2252
2273
|
"enum": [
|
|
2253
2274
|
"session",
|
|
2254
|
-
"view"
|
|
2275
|
+
"view",
|
|
2276
|
+
"tap"
|
|
2255
2277
|
]
|
|
2256
2278
|
},
|
|
2257
2279
|
"sessionId": {
|
package/openapi.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: 3.1.0
|
|
2
2
|
info:
|
|
3
3
|
title: ServiceAi API
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.11
|
|
5
5
|
description: >-
|
|
6
6
|
Source-of-truth API contract for ServiceAi. Generated from `shared/schema.ts` Zod schemas by
|
|
7
7
|
`scripts/build-api-spec.ts`. Versioning policy: see `docs/api-versioning.md`. The hand-written docs/ios-contract.md
|
|
@@ -78,7 +78,7 @@ components:
|
|
|
78
78
|
properties:
|
|
79
79
|
apiVersion:
|
|
80
80
|
type: string
|
|
81
|
-
example: 1.1.
|
|
81
|
+
example: 1.1.11
|
|
82
82
|
minClientVersion:
|
|
83
83
|
type: string
|
|
84
84
|
example: 1.0.0
|
|
@@ -1268,6 +1268,11 @@ components:
|
|
|
1268
1268
|
- left
|
|
1269
1269
|
- right
|
|
1270
1270
|
- none
|
|
1271
|
+
placementSource:
|
|
1272
|
+
type: string
|
|
1273
|
+
enum: &ref_1
|
|
1274
|
+
- auto
|
|
1275
|
+
- manual
|
|
1271
1276
|
required:
|
|
1272
1277
|
- position
|
|
1273
1278
|
- width
|
|
@@ -1307,6 +1312,9 @@ components:
|
|
|
1307
1312
|
swingHand:
|
|
1308
1313
|
type: string
|
|
1309
1314
|
enum: *ref_0
|
|
1315
|
+
placementSource:
|
|
1316
|
+
type: string
|
|
1317
|
+
enum: *ref_1
|
|
1310
1318
|
required:
|
|
1311
1319
|
- position
|
|
1312
1320
|
- width
|
|
@@ -1346,6 +1354,9 @@ components:
|
|
|
1346
1354
|
swingHand:
|
|
1347
1355
|
type: string
|
|
1348
1356
|
enum: *ref_0
|
|
1357
|
+
placementSource:
|
|
1358
|
+
type: string
|
|
1359
|
+
enum: *ref_1
|
|
1349
1360
|
required:
|
|
1350
1361
|
- position
|
|
1351
1362
|
- width
|
|
@@ -1441,6 +1452,7 @@ components:
|
|
|
1441
1452
|
enum:
|
|
1442
1453
|
- session
|
|
1443
1454
|
- view
|
|
1455
|
+
- tap
|
|
1444
1456
|
sessionId:
|
|
1445
1457
|
type: string
|
|
1446
1458
|
sessionCapturedAt:
|
|
@@ -1715,7 +1727,7 @@ paths:
|
|
|
1715
1727
|
- auth
|
|
1716
1728
|
- features
|
|
1717
1729
|
parameters:
|
|
1718
|
-
- &
|
|
1730
|
+
- &ref_2
|
|
1719
1731
|
name: X-Client-Version
|
|
1720
1732
|
in: header
|
|
1721
1733
|
required: false
|
|
@@ -1742,7 +1754,7 @@ paths:
|
|
|
1742
1754
|
tags:
|
|
1743
1755
|
- lidar
|
|
1744
1756
|
parameters:
|
|
1745
|
-
- *
|
|
1757
|
+
- *ref_2
|
|
1746
1758
|
- schema:
|
|
1747
1759
|
type: integer
|
|
1748
1760
|
exclusiveMinimum: 0
|
|
@@ -1797,7 +1809,7 @@ paths:
|
|
|
1797
1809
|
tags:
|
|
1798
1810
|
- lidar
|
|
1799
1811
|
parameters:
|
|
1800
|
-
- *
|
|
1812
|
+
- *ref_2
|
|
1801
1813
|
- schema:
|
|
1802
1814
|
type: integer
|
|
1803
1815
|
exclusiveMinimum: 0
|
|
@@ -1930,7 +1942,7 @@ paths:
|
|
|
1930
1942
|
tags:
|
|
1931
1943
|
- jobs
|
|
1932
1944
|
parameters:
|
|
1933
|
-
- *
|
|
1945
|
+
- *ref_2
|
|
1934
1946
|
responses:
|
|
1935
1947
|
'200':
|
|
1936
1948
|
description: Array of jobs.
|
|
@@ -1951,7 +1963,7 @@ paths:
|
|
|
1951
1963
|
tags:
|
|
1952
1964
|
- jobs
|
|
1953
1965
|
parameters:
|
|
1954
|
-
- *
|
|
1966
|
+
- *ref_2
|
|
1955
1967
|
requestBody:
|
|
1956
1968
|
content:
|
|
1957
1969
|
application/json:
|
|
@@ -1976,7 +1988,7 @@ paths:
|
|
|
1976
1988
|
tags:
|
|
1977
1989
|
- jobs
|
|
1978
1990
|
parameters:
|
|
1979
|
-
- *
|
|
1991
|
+
- *ref_2
|
|
1980
1992
|
- schema:
|
|
1981
1993
|
type: integer
|
|
1982
1994
|
exclusiveMinimum: 0
|
|
@@ -2008,7 +2020,7 @@ paths:
|
|
|
2008
2020
|
tags:
|
|
2009
2021
|
- chatty
|
|
2010
2022
|
parameters:
|
|
2011
|
-
- *
|
|
2023
|
+
- *ref_2
|
|
2012
2024
|
requestBody:
|
|
2013
2025
|
content:
|
|
2014
2026
|
application/json:
|
|
@@ -2045,7 +2057,7 @@ paths:
|
|
|
2045
2057
|
tags:
|
|
2046
2058
|
- chatty
|
|
2047
2059
|
parameters:
|
|
2048
|
-
- *
|
|
2060
|
+
- *ref_2
|
|
2049
2061
|
- schema:
|
|
2050
2062
|
type: string
|
|
2051
2063
|
required: true
|
|
@@ -2078,7 +2090,7 @@ paths:
|
|
|
2078
2090
|
tags:
|
|
2079
2091
|
- chatty
|
|
2080
2092
|
parameters:
|
|
2081
|
-
- *
|
|
2093
|
+
- *ref_2
|
|
2082
2094
|
- schema:
|
|
2083
2095
|
type: string
|
|
2084
2096
|
required: true
|
|
@@ -2105,7 +2117,7 @@ paths:
|
|
|
2105
2117
|
tags:
|
|
2106
2118
|
- auth
|
|
2107
2119
|
parameters:
|
|
2108
|
-
- *
|
|
2120
|
+
- *ref_2
|
|
2109
2121
|
responses:
|
|
2110
2122
|
'200':
|
|
2111
2123
|
description: Authenticated user.
|
|
@@ -2131,7 +2143,7 @@ paths:
|
|
|
2131
2143
|
tags:
|
|
2132
2144
|
- crm
|
|
2133
2145
|
parameters:
|
|
2134
|
-
- *
|
|
2146
|
+
- *ref_2
|
|
2135
2147
|
responses:
|
|
2136
2148
|
'200':
|
|
2137
2149
|
description: Array of contacts.
|
|
@@ -2329,7 +2341,7 @@ paths:
|
|
|
2329
2341
|
tags:
|
|
2330
2342
|
- crm
|
|
2331
2343
|
parameters:
|
|
2332
|
-
- *
|
|
2344
|
+
- *ref_2
|
|
2333
2345
|
requestBody:
|
|
2334
2346
|
content:
|
|
2335
2347
|
application/json:
|
|
@@ -2701,7 +2713,7 @@ paths:
|
|
|
2701
2713
|
tags:
|
|
2702
2714
|
- photos
|
|
2703
2715
|
parameters:
|
|
2704
|
-
- *
|
|
2716
|
+
- *ref_2
|
|
2705
2717
|
- schema:
|
|
2706
2718
|
type: integer
|
|
2707
2719
|
exclusiveMinimum: 0
|
|
@@ -2744,7 +2756,7 @@ paths:
|
|
|
2744
2756
|
tags:
|
|
2745
2757
|
- lidar
|
|
2746
2758
|
parameters:
|
|
2747
|
-
- *
|
|
2759
|
+
- *ref_2
|
|
2748
2760
|
- schema:
|
|
2749
2761
|
type: integer
|
|
2750
2762
|
exclusiveMinimum: 0
|
|
@@ -2767,7 +2779,7 @@ paths:
|
|
|
2767
2779
|
tags:
|
|
2768
2780
|
- lidar
|
|
2769
2781
|
parameters:
|
|
2770
|
-
- *
|
|
2782
|
+
- *ref_2
|
|
2771
2783
|
- schema:
|
|
2772
2784
|
type: integer
|
|
2773
2785
|
exclusiveMinimum: 0
|
|
@@ -2840,7 +2852,7 @@ paths:
|
|
|
2840
2852
|
tags:
|
|
2841
2853
|
- lidar
|
|
2842
2854
|
parameters:
|
|
2843
|
-
- *
|
|
2855
|
+
- *ref_2
|
|
2844
2856
|
- schema:
|
|
2845
2857
|
type: integer
|
|
2846
2858
|
exclusiveMinimum: 0
|
package/package.json
CHANGED
package/types.d.ts
CHANGED
|
@@ -1204,7 +1204,7 @@ export interface components {
|
|
|
1204
1204
|
};
|
|
1205
1205
|
/** @description Cross-platform version handshake manifest. See docs/api-versioning.md. */
|
|
1206
1206
|
VersionManifest: {
|
|
1207
|
-
/** @example 1.1.
|
|
1207
|
+
/** @example 1.1.11 */
|
|
1208
1208
|
apiVersion: string;
|
|
1209
1209
|
/** @example 1.0.0 */
|
|
1210
1210
|
minClientVersion: string;
|
|
@@ -1515,6 +1515,8 @@ export interface components {
|
|
|
1515
1515
|
wallIndex?: number;
|
|
1516
1516
|
/** @enum {string} */
|
|
1517
1517
|
swingHand?: "left" | "right" | "none";
|
|
1518
|
+
/** @enum {string} */
|
|
1519
|
+
placementSource?: "auto" | "manual";
|
|
1518
1520
|
}[];
|
|
1519
1521
|
windows?: {
|
|
1520
1522
|
position: {
|
|
@@ -1528,6 +1530,8 @@ export interface components {
|
|
|
1528
1530
|
wallIndex?: number;
|
|
1529
1531
|
/** @enum {string} */
|
|
1530
1532
|
swingHand?: "left" | "right" | "none";
|
|
1533
|
+
/** @enum {string} */
|
|
1534
|
+
placementSource?: "auto" | "manual";
|
|
1531
1535
|
}[];
|
|
1532
1536
|
openings?: {
|
|
1533
1537
|
position: {
|
|
@@ -1541,6 +1545,8 @@ export interface components {
|
|
|
1541
1545
|
wallIndex?: number;
|
|
1542
1546
|
/** @enum {string} */
|
|
1543
1547
|
swingHand?: "left" | "right" | "none";
|
|
1548
|
+
/** @enum {string} */
|
|
1549
|
+
placementSource?: "auto" | "manual";
|
|
1544
1550
|
}[];
|
|
1545
1551
|
}[];
|
|
1546
1552
|
};
|
|
@@ -1574,7 +1580,7 @@ export interface components {
|
|
|
1574
1580
|
capturedBy?: string | null;
|
|
1575
1581
|
}[];
|
|
1576
1582
|
/** @enum {string} */
|
|
1577
|
-
captureMode?: "session" | "view";
|
|
1583
|
+
captureMode?: "session" | "view" | "tap";
|
|
1578
1584
|
sessionId?: string;
|
|
1579
1585
|
sessionCapturedAt?: string;
|
|
1580
1586
|
clientMirrorApplied?: boolean;
|