@agent-ix/spec-artifacts-app 0.5.0 → 0.7.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.
- package/README.md +39 -1
- package/manifest.yaml +274 -4
- package/mappings.schema.json +318 -0
- package/mappings.yaml +386 -0
- package/package.json +10 -2
- package/schemas/Actor.json +34 -0
- package/schemas/ActorId.json +7 -0
- package/schemas/ActorKind.json +13 -0
- package/schemas/ApplicationSpec.json +116 -0
- package/schemas/ArtifactId.json +7 -0
- package/schemas/ArtifactStatus.json +7 -0
- package/schemas/Boundary.json +34 -0
- package/schemas/BoundaryId.json +7 -0
- package/schemas/BoundaryKind.json +12 -0
- package/schemas/Capability.json +37 -0
- package/schemas/CapabilityId.json +7 -0
- package/schemas/Cardinality.json +7 -0
- package/schemas/DataAccessMode.json +11 -0
- package/schemas/DataDependency.json +33 -0
- package/schemas/DataDependencyId.json +7 -0
- package/schemas/EdgeVerb.json +7 -0
- package/schemas/ImportedTypeRef.json +21 -0
- package/schemas/Interface.json +38 -0
- package/schemas/InterfaceDirection.json +11 -0
- package/schemas/InterfaceId.json +7 -0
- package/schemas/InterfaceKind.json +15 -0
- package/schemas/IxTarget.json +7 -0
- package/schemas/LineNumber.json +8 -0
- package/schemas/MasterRequirements.json +80 -0
- package/schemas/ModuleRef.json +7 -0
- package/schemas/NonEmptyText.json +7 -0
- package/schemas/Provenance.json +25 -0
- package/schemas/Relationship.json +24 -0
- package/schemas/RenderingRequirement.json +34 -0
- package/schemas/RenderingRequirementId.json +7 -0
- package/schemas/RequirementKind.json +14 -0
- package/schemas/RequirementRef.json +33 -0
- package/schemas/RequirementRefId.json +7 -0
- package/schemas/Section.json +26 -0
- package/schemas/Sha256Digest.json +7 -0
- package/schemas/TestCaseRef.json +7 -0
- package/schemas/TypeName.json +7 -0
- package/schemas/UiSurface.json +7 -0
- package/schemas/Verification.json +29 -0
- package/skeletons/application-spec.md +163 -0
- package/skeletons/application-spec.sysml.md +167 -0
- package/skeletons/master-requirements.md +104 -0
package/mappings.yaml
ADDED
|
@@ -0,0 +1,386 @@
|
|
|
1
|
+
# Markdown mapping declaration for spec-artifacts-app (FR-004).
|
|
2
|
+
#
|
|
3
|
+
# Markdown is the authority; the record is a derived projection. Every property
|
|
4
|
+
# of every exported model appears here exactly once, with the mapping kind that
|
|
5
|
+
# fills it, the Markdown form it reads, and whether that form round-trips
|
|
6
|
+
# byte-for-byte (`lossless`).
|
|
7
|
+
#
|
|
8
|
+
# `imported_types` says which types this module references from each package
|
|
9
|
+
# `manifest.yaml`'s `semantic.imports` pins. The FR-035 contract types `imports`
|
|
10
|
+
# as package -> exact semver and has no place for a per-package type list
|
|
11
|
+
# (agent-ix/quoin#339), so it is declared here, and the suite checks every
|
|
12
|
+
# `ImportedTypeRef` against both: the package in the manifest, the type here.
|
|
13
|
+
#
|
|
14
|
+
# GENERATED by `scripts/build_mappings.py` from `manifest.yaml`, so a column
|
|
15
|
+
# list, a locator name, or an id pattern is written once and cannot drift.
|
|
16
|
+
# Edit that script, not this file. `make schemas-check` fails on any drift.
|
|
17
|
+
mapping_version: 1.0.0
|
|
18
|
+
module: agent-ix/spec-artifacts-app
|
|
19
|
+
kinds:
|
|
20
|
+
- frontmatter
|
|
21
|
+
- section
|
|
22
|
+
- typed-table
|
|
23
|
+
- sysml-fence
|
|
24
|
+
- ocl-clause
|
|
25
|
+
- provenance
|
|
26
|
+
imported_types:
|
|
27
|
+
agent-ix/spec-artifacts-iso:
|
|
28
|
+
- StR
|
|
29
|
+
- US
|
|
30
|
+
- FR
|
|
31
|
+
- NFR
|
|
32
|
+
- IT
|
|
33
|
+
- TC
|
|
34
|
+
models:
|
|
35
|
+
ApplicationSpec:
|
|
36
|
+
schema: schemas/ApplicationSpec.json
|
|
37
|
+
artifact_type: ApplicationSpec
|
|
38
|
+
authority: markdown
|
|
39
|
+
round_trip: derived
|
|
40
|
+
dropped_frontmatter_keys:
|
|
41
|
+
- component_type
|
|
42
|
+
- depends_on
|
|
43
|
+
- description
|
|
44
|
+
- implementation_language
|
|
45
|
+
- object
|
|
46
|
+
- okf_version
|
|
47
|
+
- org
|
|
48
|
+
- security_critical
|
|
49
|
+
- standards_alignment
|
|
50
|
+
- tags
|
|
51
|
+
properties:
|
|
52
|
+
id:
|
|
53
|
+
kind: frontmatter
|
|
54
|
+
path:
|
|
55
|
+
- id
|
|
56
|
+
required: true
|
|
57
|
+
lossless: false
|
|
58
|
+
title:
|
|
59
|
+
kind: frontmatter
|
|
60
|
+
path:
|
|
61
|
+
- title
|
|
62
|
+
locator: title
|
|
63
|
+
required: true
|
|
64
|
+
lossless: false
|
|
65
|
+
type:
|
|
66
|
+
kind: frontmatter
|
|
67
|
+
path:
|
|
68
|
+
- type
|
|
69
|
+
required: true
|
|
70
|
+
lossless: false
|
|
71
|
+
status:
|
|
72
|
+
kind: frontmatter
|
|
73
|
+
path:
|
|
74
|
+
- status
|
|
75
|
+
lossless: false
|
|
76
|
+
relationships:
|
|
77
|
+
kind: frontmatter
|
|
78
|
+
path:
|
|
79
|
+
- relationships
|
|
80
|
+
lossless: false
|
|
81
|
+
provenance:
|
|
82
|
+
kind: provenance
|
|
83
|
+
lossless: false
|
|
84
|
+
purpose:
|
|
85
|
+
kind: section
|
|
86
|
+
heading: Purpose
|
|
87
|
+
locator: purpose
|
|
88
|
+
lossless: true
|
|
89
|
+
required: true
|
|
90
|
+
scope:
|
|
91
|
+
kind: section
|
|
92
|
+
heading: Scope
|
|
93
|
+
locator: scope
|
|
94
|
+
lossless: true
|
|
95
|
+
systemOverview:
|
|
96
|
+
kind: section
|
|
97
|
+
heading: System Overview
|
|
98
|
+
locator: system_overview
|
|
99
|
+
lossless: true
|
|
100
|
+
structure:
|
|
101
|
+
kind: section
|
|
102
|
+
heading: Structure
|
|
103
|
+
locator: structure
|
|
104
|
+
lossless: true
|
|
105
|
+
requirementsArchitecture:
|
|
106
|
+
kind: section
|
|
107
|
+
heading: Requirements Architecture
|
|
108
|
+
locator: requirements_architecture
|
|
109
|
+
lossless: true
|
|
110
|
+
references:
|
|
111
|
+
kind: section
|
|
112
|
+
heading: References
|
|
113
|
+
locator: references
|
|
114
|
+
lossless: true
|
|
115
|
+
fields:
|
|
116
|
+
kind: typed-table
|
|
117
|
+
heading: Properties
|
|
118
|
+
locator: properties_table
|
|
119
|
+
columns:
|
|
120
|
+
- Field
|
|
121
|
+
- Type
|
|
122
|
+
- Multiplicity
|
|
123
|
+
- Constraints
|
|
124
|
+
row_model: semantic-core FieldDecl
|
|
125
|
+
cell_parses:
|
|
126
|
+
Field: text
|
|
127
|
+
Type: text
|
|
128
|
+
Multiplicity: multiplicity
|
|
129
|
+
Constraints: constraints
|
|
130
|
+
alternate_form:
|
|
131
|
+
kind: sysml-fence
|
|
132
|
+
heading: Properties
|
|
133
|
+
language: sysml
|
|
134
|
+
locator: properties_fence
|
|
135
|
+
lossless: false
|
|
136
|
+
boundaries:
|
|
137
|
+
kind: typed-table
|
|
138
|
+
heading: Boundaries
|
|
139
|
+
locator: boundaries_table
|
|
140
|
+
columns:
|
|
141
|
+
- ID
|
|
142
|
+
- Name
|
|
143
|
+
- Kind
|
|
144
|
+
- Description
|
|
145
|
+
row_model: Boundary
|
|
146
|
+
id_pattern: ^{id}-BND-\d+$
|
|
147
|
+
cell_parses:
|
|
148
|
+
ID: id
|
|
149
|
+
Name: text
|
|
150
|
+
Kind: enum
|
|
151
|
+
Description: text
|
|
152
|
+
lossless: false
|
|
153
|
+
capabilities:
|
|
154
|
+
kind: typed-table
|
|
155
|
+
heading: Capabilities
|
|
156
|
+
locator: capabilities_table
|
|
157
|
+
columns:
|
|
158
|
+
- ID
|
|
159
|
+
- Name
|
|
160
|
+
- Description
|
|
161
|
+
- Actors
|
|
162
|
+
row_model: Capability
|
|
163
|
+
id_pattern: ^{id}-CAP-\d+$
|
|
164
|
+
cell_parses:
|
|
165
|
+
ID: id
|
|
166
|
+
Name: text
|
|
167
|
+
Description: text
|
|
168
|
+
Actors: id-list
|
|
169
|
+
lossless: false
|
|
170
|
+
actors:
|
|
171
|
+
kind: typed-table
|
|
172
|
+
heading: Actors
|
|
173
|
+
locator: actors_table
|
|
174
|
+
columns:
|
|
175
|
+
- ID
|
|
176
|
+
- Name
|
|
177
|
+
- Kind
|
|
178
|
+
- Description
|
|
179
|
+
row_model: Actor
|
|
180
|
+
id_pattern: ^{id}-ACT-\d+$
|
|
181
|
+
cell_parses:
|
|
182
|
+
ID: id
|
|
183
|
+
Name: text
|
|
184
|
+
Kind: enum
|
|
185
|
+
Description: text
|
|
186
|
+
lossless: false
|
|
187
|
+
interfaces:
|
|
188
|
+
kind: typed-table
|
|
189
|
+
heading: Interfaces
|
|
190
|
+
locator: interfaces_table
|
|
191
|
+
columns:
|
|
192
|
+
- ID
|
|
193
|
+
- Name
|
|
194
|
+
- Kind
|
|
195
|
+
- Direction
|
|
196
|
+
- Contract
|
|
197
|
+
row_model: Interface
|
|
198
|
+
id_pattern: ^{id}-IFC-\d+$
|
|
199
|
+
cell_parses:
|
|
200
|
+
ID: id
|
|
201
|
+
Name: text
|
|
202
|
+
Kind: enum
|
|
203
|
+
Direction: enum
|
|
204
|
+
Contract: text
|
|
205
|
+
lossless: false
|
|
206
|
+
dataDependencies:
|
|
207
|
+
kind: typed-table
|
|
208
|
+
heading: Data Dependencies
|
|
209
|
+
locator: data_dependencies_table
|
|
210
|
+
columns:
|
|
211
|
+
- ID
|
|
212
|
+
- Name
|
|
213
|
+
- Source
|
|
214
|
+
- Access
|
|
215
|
+
row_model: DataDependency
|
|
216
|
+
id_pattern: ^{id}-DAT-\d+$
|
|
217
|
+
cell_parses:
|
|
218
|
+
ID: id
|
|
219
|
+
Name: text
|
|
220
|
+
Source: imported-type-ref
|
|
221
|
+
Access: enum
|
|
222
|
+
lossless: false
|
|
223
|
+
renderingRequirements:
|
|
224
|
+
kind: typed-table
|
|
225
|
+
heading: UI Rendering Requirements
|
|
226
|
+
locator: rendering_requirements_table
|
|
227
|
+
columns:
|
|
228
|
+
- ID
|
|
229
|
+
- Surface
|
|
230
|
+
- Requirement
|
|
231
|
+
- Verification
|
|
232
|
+
row_model: RenderingRequirement
|
|
233
|
+
id_pattern: ^{id}-UI-\d+$
|
|
234
|
+
cell_parses:
|
|
235
|
+
ID: id
|
|
236
|
+
Surface: text
|
|
237
|
+
Requirement: text
|
|
238
|
+
Verification: verification
|
|
239
|
+
lossless: false
|
|
240
|
+
requirements:
|
|
241
|
+
kind: typed-table
|
|
242
|
+
heading: Requirements
|
|
243
|
+
locator: requirements_table
|
|
244
|
+
columns:
|
|
245
|
+
- ID
|
|
246
|
+
- Kind
|
|
247
|
+
- Source
|
|
248
|
+
- Target
|
|
249
|
+
row_model: RequirementRef
|
|
250
|
+
id_pattern: ^(StR|US|FR|NFR|IT|TC)-\d+$
|
|
251
|
+
cell_parses:
|
|
252
|
+
ID: id
|
|
253
|
+
Kind: enum
|
|
254
|
+
Source: imported-type-ref
|
|
255
|
+
Target: text
|
|
256
|
+
lossless: false
|
|
257
|
+
invariants:
|
|
258
|
+
kind: ocl-clause
|
|
259
|
+
heading: Invariants
|
|
260
|
+
locator: invariants
|
|
261
|
+
language: ocl
|
|
262
|
+
lossless: true
|
|
263
|
+
MasterRequirements:
|
|
264
|
+
schema: schemas/MasterRequirements.json
|
|
265
|
+
artifact_type: MasterRequirements
|
|
266
|
+
authority: markdown
|
|
267
|
+
round_trip: derived
|
|
268
|
+
dropped_frontmatter_keys:
|
|
269
|
+
- component_type
|
|
270
|
+
- depends_on
|
|
271
|
+
- description
|
|
272
|
+
- implementation_language
|
|
273
|
+
- object
|
|
274
|
+
- okf_version
|
|
275
|
+
- org
|
|
276
|
+
- security_critical
|
|
277
|
+
- standards_alignment
|
|
278
|
+
- tags
|
|
279
|
+
properties:
|
|
280
|
+
id:
|
|
281
|
+
kind: frontmatter
|
|
282
|
+
path:
|
|
283
|
+
- id
|
|
284
|
+
required: true
|
|
285
|
+
lossless: false
|
|
286
|
+
title:
|
|
287
|
+
kind: frontmatter
|
|
288
|
+
path:
|
|
289
|
+
- title
|
|
290
|
+
locator: title
|
|
291
|
+
required: true
|
|
292
|
+
lossless: false
|
|
293
|
+
type:
|
|
294
|
+
kind: frontmatter
|
|
295
|
+
path:
|
|
296
|
+
- type
|
|
297
|
+
required: true
|
|
298
|
+
lossless: false
|
|
299
|
+
status:
|
|
300
|
+
kind: frontmatter
|
|
301
|
+
path:
|
|
302
|
+
- status
|
|
303
|
+
lossless: false
|
|
304
|
+
relationships:
|
|
305
|
+
kind: frontmatter
|
|
306
|
+
path:
|
|
307
|
+
- relationships
|
|
308
|
+
lossless: false
|
|
309
|
+
provenance:
|
|
310
|
+
kind: provenance
|
|
311
|
+
lossless: false
|
|
312
|
+
purpose:
|
|
313
|
+
kind: section
|
|
314
|
+
heading: Purpose
|
|
315
|
+
locator: purpose
|
|
316
|
+
lossless: true
|
|
317
|
+
required: true
|
|
318
|
+
scope:
|
|
319
|
+
kind: section
|
|
320
|
+
heading: Scope
|
|
321
|
+
locator: scope
|
|
322
|
+
lossless: true
|
|
323
|
+
systemOverview:
|
|
324
|
+
kind: section
|
|
325
|
+
heading: System Overview
|
|
326
|
+
locator: system_overview
|
|
327
|
+
lossless: true
|
|
328
|
+
structure:
|
|
329
|
+
kind: section
|
|
330
|
+
heading: Structure
|
|
331
|
+
locator: structure
|
|
332
|
+
lossless: true
|
|
333
|
+
requirementsArchitecture:
|
|
334
|
+
kind: section
|
|
335
|
+
heading: Requirements Architecture
|
|
336
|
+
locator: requirements_architecture
|
|
337
|
+
lossless: true
|
|
338
|
+
references:
|
|
339
|
+
kind: section
|
|
340
|
+
heading: References
|
|
341
|
+
locator: references
|
|
342
|
+
lossless: true
|
|
343
|
+
fields:
|
|
344
|
+
kind: typed-table
|
|
345
|
+
heading: Properties
|
|
346
|
+
locator: properties_table
|
|
347
|
+
columns:
|
|
348
|
+
- Field
|
|
349
|
+
- Type
|
|
350
|
+
- Multiplicity
|
|
351
|
+
- Constraints
|
|
352
|
+
row_model: semantic-core FieldDecl
|
|
353
|
+
cell_parses:
|
|
354
|
+
Field: text
|
|
355
|
+
Type: text
|
|
356
|
+
Multiplicity: multiplicity
|
|
357
|
+
Constraints: constraints
|
|
358
|
+
alternate_form:
|
|
359
|
+
kind: sysml-fence
|
|
360
|
+
heading: Properties
|
|
361
|
+
language: sysml
|
|
362
|
+
locator: properties_fence
|
|
363
|
+
lossless: false
|
|
364
|
+
requirements:
|
|
365
|
+
kind: typed-table
|
|
366
|
+
heading: Requirements
|
|
367
|
+
locator: requirements_table
|
|
368
|
+
columns:
|
|
369
|
+
- ID
|
|
370
|
+
- Kind
|
|
371
|
+
- Source
|
|
372
|
+
- Target
|
|
373
|
+
row_model: RequirementRef
|
|
374
|
+
id_pattern: ^(StR|US|FR|NFR|IT|TC)-\d+$
|
|
375
|
+
cell_parses:
|
|
376
|
+
ID: id
|
|
377
|
+
Kind: enum
|
|
378
|
+
Source: imported-type-ref
|
|
379
|
+
Target: text
|
|
380
|
+
lossless: false
|
|
381
|
+
invariants:
|
|
382
|
+
kind: ocl-clause
|
|
383
|
+
heading: Invariants
|
|
384
|
+
locator: invariants
|
|
385
|
+
language: ocl
|
|
386
|
+
lossless: true
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-ix/spec-artifacts-app",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "Filament Module: application/composite spec artifacts including master-requirements",
|
|
5
5
|
"license": "AGPL-3.0-or-later",
|
|
6
6
|
"author": "Agent IX <agents@agent-ix.dev>",
|
|
@@ -16,11 +16,14 @@
|
|
|
16
16
|
"manifest.yaml",
|
|
17
17
|
"schemas/",
|
|
18
18
|
"skeletons/",
|
|
19
|
+
"mappings.yaml",
|
|
20
|
+
"mappings.schema.json",
|
|
19
21
|
"README.md",
|
|
20
22
|
"LICENSE"
|
|
21
23
|
],
|
|
22
24
|
"scripts": {
|
|
23
|
-
"prepack": "node scripts/stage-npm.mjs"
|
|
25
|
+
"prepack": "node scripts/stage-npm.mjs",
|
|
26
|
+
"postpack": "node scripts/stage-npm.mjs --clean"
|
|
24
27
|
},
|
|
25
28
|
"publishConfig": {
|
|
26
29
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -29,5 +32,10 @@
|
|
|
29
32
|
"repository": {
|
|
30
33
|
"type": "git",
|
|
31
34
|
"url": "git+https://github.com/agent-ix/spec-artifacts-app.git"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@agent-ix/semantic-core": "0.3.0",
|
|
38
|
+
"@typespec/compiler": "1.15.0",
|
|
39
|
+
"@typespec/json-schema": "1.15.0"
|
|
32
40
|
}
|
|
33
41
|
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Actor.json",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"id": {
|
|
7
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ActorId.json"
|
|
8
|
+
},
|
|
9
|
+
"name": {
|
|
10
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/NonEmptyText.json"
|
|
11
|
+
},
|
|
12
|
+
"kind": {
|
|
13
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ActorKind.json"
|
|
14
|
+
},
|
|
15
|
+
"description": {
|
|
16
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/NonEmptyText.json",
|
|
17
|
+
"description": "free text: authored prose describing the actor's role."
|
|
18
|
+
},
|
|
19
|
+
"line": {
|
|
20
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/LineNumber.json"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"required": [
|
|
24
|
+
"id",
|
|
25
|
+
"name",
|
|
26
|
+
"kind",
|
|
27
|
+
"description",
|
|
28
|
+
"line"
|
|
29
|
+
],
|
|
30
|
+
"unevaluatedProperties": {
|
|
31
|
+
"not": {}
|
|
32
|
+
},
|
|
33
|
+
"description": "One row of `## Actors`: who or what interacts with the application."
|
|
34
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ActorId.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"pattern": "^[A-Z]{2,4}-[0-9]+-ACT-[0-9]+$",
|
|
6
|
+
"description": "Actor row id, `<document id>-ACT-N`."
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ActorKind.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"enum": [
|
|
6
|
+
"human",
|
|
7
|
+
"service",
|
|
8
|
+
"agent",
|
|
9
|
+
"external_system",
|
|
10
|
+
"scheduler"
|
|
11
|
+
],
|
|
12
|
+
"description": "What kind of actor interacts with the application."
|
|
13
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ApplicationSpec.json",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"id": {
|
|
7
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ArtifactId.json"
|
|
8
|
+
},
|
|
9
|
+
"title": {
|
|
10
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/NonEmptyText.json"
|
|
11
|
+
},
|
|
12
|
+
"type": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "ApplicationSpec"
|
|
15
|
+
},
|
|
16
|
+
"status": {
|
|
17
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ArtifactStatus.json"
|
|
18
|
+
},
|
|
19
|
+
"relationships": {
|
|
20
|
+
"type": "array",
|
|
21
|
+
"items": {
|
|
22
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Relationship.json"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"provenance": {
|
|
26
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Provenance.json"
|
|
27
|
+
},
|
|
28
|
+
"purpose": {
|
|
29
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
30
|
+
},
|
|
31
|
+
"scope": {
|
|
32
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
33
|
+
},
|
|
34
|
+
"systemOverview": {
|
|
35
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
36
|
+
},
|
|
37
|
+
"structure": {
|
|
38
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
39
|
+
},
|
|
40
|
+
"requirementsArchitecture": {
|
|
41
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
42
|
+
},
|
|
43
|
+
"references": {
|
|
44
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Section.json"
|
|
45
|
+
},
|
|
46
|
+
"fields": {
|
|
47
|
+
"type": "array",
|
|
48
|
+
"items": {
|
|
49
|
+
"$ref": "https://schemas.agent-ix.org/semantic-core/0.3.0/FieldDecl.json"
|
|
50
|
+
},
|
|
51
|
+
"minItems": 1,
|
|
52
|
+
"description": "The application's identity attributes, declared as one typed row per field\nin `## Properties` (`Field | Type | Multiplicity | Constraints`) or, as the\nalternate form of the same declarations, as one `sysml` fence under the\nsame heading. Each row is a semantic-core `FieldDecl`; no field of it is\nredeclared here (quoin FR-071)."
|
|
53
|
+
},
|
|
54
|
+
"boundaries": {
|
|
55
|
+
"type": "array",
|
|
56
|
+
"items": {
|
|
57
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Boundary.json"
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"capabilities": {
|
|
61
|
+
"type": "array",
|
|
62
|
+
"items": {
|
|
63
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Capability.json"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"actors": {
|
|
67
|
+
"type": "array",
|
|
68
|
+
"items": {
|
|
69
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Actor.json"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"interfaces": {
|
|
73
|
+
"type": "array",
|
|
74
|
+
"items": {
|
|
75
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Interface.json"
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"dataDependencies": {
|
|
79
|
+
"type": "array",
|
|
80
|
+
"items": {
|
|
81
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/DataDependency.json"
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"renderingRequirements": {
|
|
85
|
+
"type": "array",
|
|
86
|
+
"items": {
|
|
87
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/RenderingRequirement.json"
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
"requirements": {
|
|
91
|
+
"type": "array",
|
|
92
|
+
"items": {
|
|
93
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/RequirementRef.json"
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"invariants": {
|
|
97
|
+
"type": "array",
|
|
98
|
+
"items": {
|
|
99
|
+
"$ref": "https://schemas.agent-ix.org/semantic-core/0.3.0/ClauseRef.json"
|
|
100
|
+
},
|
|
101
|
+
"minItems": 1
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"required": [
|
|
105
|
+
"id",
|
|
106
|
+
"title",
|
|
107
|
+
"type",
|
|
108
|
+
"relationships",
|
|
109
|
+
"provenance",
|
|
110
|
+
"purpose"
|
|
111
|
+
],
|
|
112
|
+
"unevaluatedProperties": {
|
|
113
|
+
"not": {}
|
|
114
|
+
},
|
|
115
|
+
"description": "The record of an `ApplicationSpec` document: an application's identity, its\nboundaries, capabilities, actors, interfaces, data dependencies, UI rendering\nrequirements, and the requirements it aggregates.\n\nThis model describes an application *declaration*, and\nruntime state (deployment, health, uptime) is not modelled: a deployed\ninstance's condition belongs to the platform that runs it, never to the\ndocument that specifies it (FR-002-CON-4)."
|
|
116
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ArtifactId.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"pattern": "^[A-Z]{2,4}-[0-9]+$",
|
|
6
|
+
"description": "Artifact id as the frontmatter schemas of this module already pin it:\na 2..4 letter prefix and a number (`AS-001`, `MR-001`)."
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/ArtifactStatus.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"pattern": "^[A-Za-z][A-Za-z_-]*$",
|
|
6
|
+
"description": "Lifecycle status from frontmatter `status`. The value set is deliberately\nopen: closing it is a vocabulary sweep-and-report, not a side effect of this\nschema set (spec.md Out of Scope)."
|
|
7
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/Boundary.json",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"id": {
|
|
7
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/BoundaryId.json"
|
|
8
|
+
},
|
|
9
|
+
"name": {
|
|
10
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/NonEmptyText.json"
|
|
11
|
+
},
|
|
12
|
+
"kind": {
|
|
13
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/BoundaryKind.json"
|
|
14
|
+
},
|
|
15
|
+
"description": {
|
|
16
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/NonEmptyText.json",
|
|
17
|
+
"description": "free text: authored prose describing the area; no closed vocabulary describes an application's areas."
|
|
18
|
+
},
|
|
19
|
+
"line": {
|
|
20
|
+
"$ref": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/LineNumber.json"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"required": [
|
|
24
|
+
"id",
|
|
25
|
+
"name",
|
|
26
|
+
"kind",
|
|
27
|
+
"description",
|
|
28
|
+
"line"
|
|
29
|
+
],
|
|
30
|
+
"unevaluatedProperties": {
|
|
31
|
+
"not": {}
|
|
32
|
+
},
|
|
33
|
+
"description": "One row of `## Boundaries`: a named area and how it sits relative to the application."
|
|
34
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/BoundaryId.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"pattern": "^[A-Z]{2,4}-[0-9]+-BND-[0-9]+$",
|
|
6
|
+
"description": "Boundary row id, `<document id>-BND-N`."
|
|
7
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/BoundaryKind.json",
|
|
4
|
+
"type": "string",
|
|
5
|
+
"enum": [
|
|
6
|
+
"owned",
|
|
7
|
+
"consumed",
|
|
8
|
+
"external",
|
|
9
|
+
"deferred"
|
|
10
|
+
],
|
|
11
|
+
"description": "How a named area sits relative to the application's boundary."
|
|
12
|
+
}
|