@openplanr/protocol 0.11.0 → 0.12.0

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.
@@ -0,0 +1,267 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.19.0/enterprise-artifact-page.schema.json",
4
+ "x-openplanr-contract": {
5
+ "id": "enterprise-artifact-page",
6
+ "version": "1.19.0"
7
+ },
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "kind": {
12
+ "const": "openplanr-enterprise-artifact-page"
13
+ },
14
+ "schemaVersion": {
15
+ "const": "1.0.0"
16
+ },
17
+ "protocolVersion": {
18
+ "const": "1.19.0"
19
+ },
20
+ "query": {
21
+ "type": "object",
22
+ "additionalProperties": false,
23
+ "properties": {
24
+ "organizationId": {
25
+ "type": "string",
26
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
27
+ },
28
+ "projectId": {
29
+ "type": "string",
30
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
31
+ },
32
+ "actorId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
35
+ },
36
+ "scope": {
37
+ "const": "artifacts"
38
+ },
39
+ "filter": {
40
+ "type": "object",
41
+ "additionalProperties": false,
42
+ "properties": {
43
+ "kind": {
44
+ "enum": [
45
+ "all",
46
+ "diagram",
47
+ "design",
48
+ "artifact"
49
+ ]
50
+ },
51
+ "contentFormat": {
52
+ "enum": [
53
+ "all",
54
+ "diagram-authoring",
55
+ "design-review",
56
+ "planning-document",
57
+ "generic-artifact"
58
+ ]
59
+ },
60
+ "status": {
61
+ "enum": [
62
+ "all",
63
+ "active",
64
+ "archived"
65
+ ]
66
+ },
67
+ "search": {
68
+ "type": "string",
69
+ "maxLength": 240
70
+ }
71
+ },
72
+ "required": [
73
+ "kind",
74
+ "status",
75
+ "search"
76
+ ]
77
+ }
78
+ },
79
+ "required": [
80
+ "organizationId",
81
+ "projectId",
82
+ "actorId",
83
+ "scope",
84
+ "filter"
85
+ ]
86
+ },
87
+ "items": {
88
+ "type": "array",
89
+ "items": {
90
+ "type": "object",
91
+ "additionalProperties": false,
92
+ "properties": {
93
+ "organizationId": {
94
+ "type": "string",
95
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
96
+ },
97
+ "projectId": {
98
+ "type": "string",
99
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
100
+ },
101
+ "artifactId": {
102
+ "type": "string",
103
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
104
+ },
105
+ "kind": {
106
+ "enum": [
107
+ "diagram",
108
+ "design",
109
+ "artifact"
110
+ ]
111
+ },
112
+ "contentFormat": {
113
+ "enum": [
114
+ "diagram-authoring",
115
+ "design-review",
116
+ "planning-document",
117
+ "generic-artifact"
118
+ ]
119
+ },
120
+ "title": {
121
+ "type": "string",
122
+ "minLength": 1,
123
+ "maxLength": 240
124
+ },
125
+ "revisionId": {
126
+ "oneOf": [
127
+ {
128
+ "type": "string",
129
+ "pattern": "^[A-Za-z0-9_-]{1,128}(?![\\s\\S])"
130
+ },
131
+ {
132
+ "type": "null"
133
+ }
134
+ ]
135
+ },
136
+ "status": {
137
+ "enum": [
138
+ "active",
139
+ "archived"
140
+ ]
141
+ },
142
+ "capabilities": {
143
+ "type": "array",
144
+ "items": {
145
+ "enum": [
146
+ "organization.manage",
147
+ "ownership.transfer",
148
+ "billing.manage",
149
+ "audit.read",
150
+ "project.create",
151
+ "project.manage",
152
+ "artifact.read",
153
+ "artifact.author",
154
+ "artifact.export",
155
+ "review.write",
156
+ "review.resolve"
157
+ ]
158
+ },
159
+ "maxItems": 11,
160
+ "minItems": 0,
161
+ "uniqueItems": true
162
+ }
163
+ },
164
+ "required": [
165
+ "organizationId",
166
+ "projectId",
167
+ "artifactId",
168
+ "kind",
169
+ "contentFormat",
170
+ "title",
171
+ "revisionId",
172
+ "status",
173
+ "capabilities"
174
+ ],
175
+ "allOf": [
176
+ {
177
+ "if": {
178
+ "properties": {
179
+ "kind": {
180
+ "const": "diagram"
181
+ }
182
+ }
183
+ },
184
+ "then": {
185
+ "properties": {
186
+ "contentFormat": {
187
+ "const": "diagram-authoring"
188
+ }
189
+ }
190
+ }
191
+ },
192
+ {
193
+ "if": {
194
+ "properties": {
195
+ "kind": {
196
+ "const": "design"
197
+ }
198
+ }
199
+ },
200
+ "then": {
201
+ "properties": {
202
+ "contentFormat": {
203
+ "const": "design-review"
204
+ }
205
+ }
206
+ }
207
+ },
208
+ {
209
+ "if": {
210
+ "properties": {
211
+ "kind": {
212
+ "const": "artifact"
213
+ }
214
+ }
215
+ },
216
+ "then": {
217
+ "properties": {
218
+ "contentFormat": {
219
+ "enum": [
220
+ "planning-document",
221
+ "generic-artifact"
222
+ ]
223
+ }
224
+ }
225
+ }
226
+ }
227
+ ]
228
+ },
229
+ "maxItems": 100,
230
+ "minItems": 0
231
+ },
232
+ "nextCursor": {
233
+ "oneOf": [
234
+ {
235
+ "type": "object",
236
+ "additionalProperties": false,
237
+ "properties": {
238
+ "token": {
239
+ "type": "string",
240
+ "minLength": 1,
241
+ "maxLength": 2048
242
+ },
243
+ "queryDigest": {
244
+ "type": "string",
245
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
246
+ }
247
+ },
248
+ "required": [
249
+ "token",
250
+ "queryDigest"
251
+ ]
252
+ },
253
+ {
254
+ "type": "null"
255
+ }
256
+ ]
257
+ }
258
+ },
259
+ "required": [
260
+ "kind",
261
+ "schemaVersion",
262
+ "protocolVersion",
263
+ "query",
264
+ "items",
265
+ "nextCursor"
266
+ ]
267
+ }
@@ -0,0 +1,179 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.19.0/enterprise-guest-authorization.schema.json",
4
+ "x-openplanr-contract": {
5
+ "id": "enterprise-guest-authorization",
6
+ "version": "1.19.0"
7
+ },
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "kind": {
12
+ "const": "openplanr-enterprise-guest-authorization"
13
+ },
14
+ "schemaVersion": {
15
+ "const": "1.0.0"
16
+ },
17
+ "protocolVersion": {
18
+ "const": "1.19.0"
19
+ },
20
+ "organizationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
23
+ },
24
+ "projectId": {
25
+ "type": "string",
26
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
27
+ },
28
+ "artifactId": {
29
+ "type": "string",
30
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
31
+ },
32
+ "authorizationId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
35
+ },
36
+ "operationId": {
37
+ "type": "string",
38
+ "pattern": "^[A-Za-z0-9_-]{22,64}(?![\\s\\S])"
39
+ },
40
+ "invitationId": {
41
+ "type": "string",
42
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
43
+ },
44
+ "actorId": {
45
+ "type": "string",
46
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
47
+ },
48
+ "role": {
49
+ "enum": [
50
+ "reviewer",
51
+ "viewer"
52
+ ]
53
+ },
54
+ "binding": {
55
+ "const": "fixed"
56
+ },
57
+ "pin": {
58
+ "type": "object",
59
+ "additionalProperties": false,
60
+ "properties": {
61
+ "revisionId": {
62
+ "type": "string",
63
+ "pattern": "^[A-Za-z0-9_-]{1,128}(?![\\s\\S])"
64
+ },
65
+ "contentDigest": {
66
+ "type": "string",
67
+ "pattern": "^sha256:[a-f0-9]{64}(?![\\s\\S])"
68
+ },
69
+ "publicationId": {
70
+ "type": "string",
71
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
72
+ }
73
+ },
74
+ "required": [
75
+ "revisionId",
76
+ "contentDigest",
77
+ "publicationId"
78
+ ]
79
+ },
80
+ "status": {
81
+ "enum": [
82
+ "pending",
83
+ "active",
84
+ "denied",
85
+ "revoked"
86
+ ]
87
+ },
88
+ "lifecycleEpoch": {
89
+ "type": "integer",
90
+ "minimum": 1,
91
+ "maximum": 9007199254740991
92
+ },
93
+ "expiresAt": {
94
+ "type": "string",
95
+ "format": "date-time",
96
+ "maxLength": 40,
97
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z(?![\\s\\S])"
98
+ },
99
+ "receipt": {
100
+ "type": "object",
101
+ "additionalProperties": false,
102
+ "properties": {
103
+ "receiptId": {
104
+ "type": "string",
105
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
106
+ },
107
+ "operationId": {
108
+ "type": "string",
109
+ "pattern": "^[A-Za-z0-9_-]{22,64}(?![\\s\\S])"
110
+ },
111
+ "authorizedAt": {
112
+ "type": "string",
113
+ "format": "date-time",
114
+ "maxLength": 40,
115
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z(?![\\s\\S])"
116
+ },
117
+ "publicationHeadAdvanced": {
118
+ "const": false
119
+ }
120
+ },
121
+ "required": [
122
+ "receiptId",
123
+ "operationId",
124
+ "authorizedAt",
125
+ "publicationHeadAdvanced"
126
+ ]
127
+ }
128
+ },
129
+ "required": [
130
+ "kind",
131
+ "schemaVersion",
132
+ "protocolVersion",
133
+ "organizationId",
134
+ "projectId",
135
+ "artifactId",
136
+ "authorizationId",
137
+ "operationId",
138
+ "invitationId",
139
+ "actorId",
140
+ "role",
141
+ "binding",
142
+ "pin",
143
+ "status",
144
+ "lifecycleEpoch",
145
+ "expiresAt"
146
+ ],
147
+ "allOf": [
148
+ {
149
+ "if": {
150
+ "properties": {
151
+ "status": {
152
+ "const": "active"
153
+ }
154
+ }
155
+ },
156
+ "then": {
157
+ "required": [
158
+ "receipt"
159
+ ]
160
+ }
161
+ },
162
+ {
163
+ "if": {
164
+ "properties": {
165
+ "status": {
166
+ "const": "pending"
167
+ }
168
+ }
169
+ },
170
+ "then": {
171
+ "not": {
172
+ "required": [
173
+ "receipt"
174
+ ]
175
+ }
176
+ }
177
+ }
178
+ ]
179
+ }
@@ -0,0 +1,128 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.19.0/enterprise-guest-invitation.schema.json",
4
+ "x-openplanr-contract": {
5
+ "id": "enterprise-guest-invitation",
6
+ "version": "1.19.0"
7
+ },
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "kind": {
12
+ "const": "openplanr-enterprise-guest-invitation"
13
+ },
14
+ "schemaVersion": {
15
+ "const": "1.0.0"
16
+ },
17
+ "protocolVersion": {
18
+ "const": "1.19.0"
19
+ },
20
+ "organizationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
23
+ },
24
+ "projectId": {
25
+ "type": "string",
26
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
27
+ },
28
+ "artifactId": {
29
+ "type": "string",
30
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
31
+ },
32
+ "invitationId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
35
+ },
36
+ "deliveryOperationId": {
37
+ "type": "string",
38
+ "pattern": "^[A-Za-z0-9_-]{22,64}(?![\\s\\S])"
39
+ },
40
+ "inviterId": {
41
+ "type": "string",
42
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
43
+ },
44
+ "recipientId": {
45
+ "type": "string",
46
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
47
+ },
48
+ "role": {
49
+ "enum": [
50
+ "reviewer",
51
+ "viewer"
52
+ ]
53
+ },
54
+ "binding": {
55
+ "const": "fixed"
56
+ },
57
+ "pin": {
58
+ "type": "object",
59
+ "additionalProperties": false,
60
+ "properties": {
61
+ "revisionId": {
62
+ "type": "string",
63
+ "pattern": "^[A-Za-z0-9_-]{1,128}(?![\\s\\S])"
64
+ },
65
+ "contentDigest": {
66
+ "type": "string",
67
+ "pattern": "^sha256:[a-f0-9]{64}(?![\\s\\S])"
68
+ },
69
+ "publicationId": {
70
+ "type": "string",
71
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
72
+ }
73
+ },
74
+ "required": [
75
+ "revisionId",
76
+ "contentDigest",
77
+ "publicationId"
78
+ ]
79
+ },
80
+ "deliveryStatus": {
81
+ "enum": [
82
+ "queued",
83
+ "failed",
84
+ "delivered",
85
+ "expired"
86
+ ]
87
+ },
88
+ "grantStatus": {
89
+ "enum": [
90
+ "pending",
91
+ "active",
92
+ "denied",
93
+ "revoked"
94
+ ]
95
+ },
96
+ "createdAt": {
97
+ "type": "string",
98
+ "format": "date-time",
99
+ "maxLength": 40,
100
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z(?![\\s\\S])"
101
+ },
102
+ "expiresAt": {
103
+ "type": "string",
104
+ "format": "date-time",
105
+ "maxLength": 40,
106
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z(?![\\s\\S])"
107
+ }
108
+ },
109
+ "required": [
110
+ "kind",
111
+ "schemaVersion",
112
+ "protocolVersion",
113
+ "organizationId",
114
+ "projectId",
115
+ "artifactId",
116
+ "invitationId",
117
+ "deliveryOperationId",
118
+ "inviterId",
119
+ "recipientId",
120
+ "role",
121
+ "binding",
122
+ "pin",
123
+ "deliveryStatus",
124
+ "grantStatus",
125
+ "createdAt",
126
+ "expiresAt"
127
+ ]
128
+ }
@@ -0,0 +1,83 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.19.0/enterprise-journey-capabilities.schema.json",
4
+ "x-openplanr-contract": {
5
+ "id": "enterprise-journey-capabilities",
6
+ "version": "1.19.0"
7
+ },
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "kind": {
12
+ "const": "openplanr-enterprise-journey-capabilities"
13
+ },
14
+ "schemaVersion": {
15
+ "const": "1.0.0"
16
+ },
17
+ "protocolVersion": {
18
+ "const": "1.19.0"
19
+ },
20
+ "readers": {
21
+ "type": "array",
22
+ "items": {
23
+ "enum": [
24
+ "resource-draft",
25
+ "resource-publication",
26
+ "fixed-guest",
27
+ "project-lifecycle",
28
+ "review-mentions",
29
+ "scoped-pages"
30
+ ]
31
+ },
32
+ "maxItems": 6,
33
+ "minItems": 0,
34
+ "uniqueItems": true
35
+ },
36
+ "writers": {
37
+ "type": "array",
38
+ "items": {
39
+ "enum": [
40
+ "resource-draft",
41
+ "resource-publication",
42
+ "fixed-guest",
43
+ "project-lifecycle",
44
+ "review-mentions",
45
+ "scoped-pages"
46
+ ]
47
+ },
48
+ "maxItems": 6,
49
+ "minItems": 0,
50
+ "uniqueItems": true
51
+ },
52
+ "rollbackFloor": {
53
+ "type": "object",
54
+ "additionalProperties": false,
55
+ "properties": {
56
+ "protocolVersion": {
57
+ "const": "1.19.0"
58
+ },
59
+ "serviceVersion": {
60
+ "type": "string",
61
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}(?![\\s\\S])"
62
+ },
63
+ "candidateDigest": {
64
+ "type": "string",
65
+ "pattern": "^sha256:[a-f0-9]{64}(?![\\s\\S])"
66
+ }
67
+ },
68
+ "required": [
69
+ "protocolVersion",
70
+ "serviceVersion",
71
+ "candidateDigest"
72
+ ]
73
+ }
74
+ },
75
+ "required": [
76
+ "kind",
77
+ "schemaVersion",
78
+ "protocolVersion",
79
+ "readers",
80
+ "writers",
81
+ "rollbackFloor"
82
+ ]
83
+ }