@agent-ix/spec-artifacts-app 0.5.0 → 0.6.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 +40 -1
- package/manifest.yaml +276 -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/schemas/toolchain.json +65 -0
- package/skeletons/application-spec.md +163 -0
- package/skeletons/application-spec.sysml.md +167 -0
- package/skeletons/master-requirements.md +104 -0
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# spec-artifacts-app
|
|
2
2
|
|
|
3
|
+
[](https://discord.gg/6qsdhSPE)
|
|
4
|
+
|
|
3
5
|
> Filament Module: application/composite spec artifact templates (ApplicationSpec, MasterRequirements) — absorbed spec-master-requirements
|
|
4
6
|
|
|
5
7
|
Agent-IX Filament module loaded by [`quire-cli`](https://github.com/agent-ix/quire-cli) and [`quoin`](https://github.com/agent-ix/quoin).
|
|
@@ -32,6 +34,26 @@ quoin plugin install package:@agent-ix/spec-artifacts-app
|
|
|
32
34
|
quire validate spec/**/*.md --module node_modules/@agent-ix/spec-artifacts-app
|
|
33
35
|
```
|
|
34
36
|
|
|
37
|
+
## The semantic contract
|
|
38
|
+
|
|
39
|
+
Since 0.2.0 this module declares a **semantic data model per artifact type**, so a
|
|
40
|
+
consumer can read an application composite as a typed record instead of
|
|
41
|
+
re-parsing its prose:
|
|
42
|
+
|
|
43
|
+
- `typespec/main.tsp` is the source, importing `@agent-ix/semantic-core` 0.3.0.
|
|
44
|
+
- `schemas/<Model>.json` is the emitted JSON Schema 2020-12 bundle (39 files),
|
|
45
|
+
with `schemas/toolchain.json` recording the projection's provenance.
|
|
46
|
+
- `manifest.yaml` carries the quoin FR-070 `semantic` block, and every artifact
|
|
47
|
+
type references its schema by path and SHA-256 digest.
|
|
48
|
+
- `mappings.yaml` declares, per record property, which Markdown form fills it and
|
|
49
|
+
whether that form round-trips byte-for-byte.
|
|
50
|
+
- `skeletons/` are executable fixtures: a typed `## Properties` table, a `sysml`
|
|
51
|
+
fence as its alternate form, and `ocl` clauses under `## Invariants`.
|
|
52
|
+
|
|
53
|
+
An application composite **references** what other modules own rather than
|
|
54
|
+
restating it: an aggregated requirement or a data source is an
|
|
55
|
+
`{module, type}` pair plus an id, never a copy of the imported type's fields.
|
|
56
|
+
|
|
35
57
|
## What's in this module
|
|
36
58
|
|
|
37
59
|
This module gives you the top-level document kinds for specifying a whole application — the documents that gather requirements together and describe the system as a whole. They sit above the individual requirement artifacts (`StR`, `FR`, `NFR`, …) and tie them into one specification.
|
|
@@ -72,7 +94,10 @@ See https://github.com/agent-ix/quire-cli#usage-instructions.
|
|
|
72
94
|
- **Build/CI:** GitHub Actions; dynamic Git-tag-based versioning; publishes wheel + sdist to Google Artifact Registry via `twine upload -r internal-pypi`.
|
|
73
95
|
|
|
74
96
|
```bash
|
|
75
|
-
make install # install deps in Poetry venv
|
|
97
|
+
make install # poetry install: deps in the Poetry venv, including quire
|
|
98
|
+
make semantic-install # npm ci for the pinned TypeSpec toolchain
|
|
99
|
+
make schemas # emit the JSON Schemas and refresh the derived files
|
|
100
|
+
make schemas-check # fail when the committed schemas or digests drift
|
|
76
101
|
make test # run pytest
|
|
77
102
|
make lint # ruff + black check
|
|
78
103
|
make format # ruff + black format
|
|
@@ -81,4 +106,18 @@ make local-publish # build and publish to local PyPI (pypi.ix)
|
|
|
81
106
|
make update-lock # update poetry.lock
|
|
82
107
|
```
|
|
83
108
|
|
|
109
|
+
Two environment preconditions, both deliberate and both recorded in NFR-001:
|
|
110
|
+
|
|
111
|
+
- `@agent-ix/semantic-core` resolves only from the registry your npm
|
|
112
|
+
configuration routes the `@agent-ix` scope to. The repository carries no
|
|
113
|
+
`.npmrc`, so the routing is your machine's; `agent-ix/filament-core-data#11`
|
|
114
|
+
tracks the public publish.
|
|
115
|
+
- The Quire wheel exposing `extract_semantic` is a `pyproject.toml` dev
|
|
116
|
+
dependency pinned to the `internal-pypi` source, provisioned by
|
|
117
|
+
`poetry install`. The semantic tests **fail** rather than skip when it is
|
|
118
|
+
absent, because a skipped row is not coverage.
|
|
119
|
+
|
|
120
|
+
The offline, no-network gate is a manual procedure: see
|
|
121
|
+
[docs/offline-gate.md](docs/offline-gate.md).
|
|
122
|
+
|
|
84
123
|
CI requires the `GCP_SERVICE_ACCOUNT_KEY` secret plus `GCP_REGION`, `GCP_PROJECT_NAME`, and `GCP_PYPI` variables for Artifact Registry publishing.
|
package/manifest.yaml
CHANGED
|
@@ -1,7 +1,29 @@
|
|
|
1
1
|
manifest_version: 1.0.0
|
|
2
2
|
name: spec-artifacts-app
|
|
3
|
-
version: 0.
|
|
4
|
-
description: "Filament Module: application/composite spec artifact templates (ApplicationSpec, MasterRequirements)
|
|
3
|
+
version: 0.2.0
|
|
4
|
+
description: "Filament Module: application/composite spec artifact templates (ApplicationSpec, MasterRequirements) — absorbed spec-master-requirements"
|
|
5
|
+
# Semantic-module contract (quoin FR-070/FR-073, agent-ix/spec-artifacts-app#3).
|
|
6
|
+
# `imports` names every module whose types this module's artifacts reference;
|
|
7
|
+
# an artifact references an imported type through `{module, type}` and an id,
|
|
8
|
+
# never by restating the imported type's fields (FR-002-AC-10, FR-003-AC-4).
|
|
9
|
+
semantic:
|
|
10
|
+
contract_version: 1.0.0
|
|
11
|
+
semantic_core: 0.3.0
|
|
12
|
+
package: agent-ix/spec-artifacts-app
|
|
13
|
+
exports:
|
|
14
|
+
- ApplicationSpec
|
|
15
|
+
- MasterRequirements
|
|
16
|
+
# FR-035 types `imports` as `<org>/<repo>` -> exact semver, and nothing more.
|
|
17
|
+
# The *types* this module references from each imported package are declared
|
|
18
|
+
# in `mappings.yaml` under `imported_types`, because the contract has no place
|
|
19
|
+
# for them yet (agent-ix/quoin#339). The suite checks every `ImportedTypeRef`
|
|
20
|
+
# against both: the package here, the type there.
|
|
21
|
+
imports:
|
|
22
|
+
agent-ix/spec-artifacts-iso: 0.2.0
|
|
23
|
+
targets: [json-schema, markdown]
|
|
24
|
+
mappings: [frontmatter, section, typed-table, sysml-fence, ocl-clause, provenance]
|
|
25
|
+
compatibility_posture: additive
|
|
26
|
+
legacy_forms: warning
|
|
5
27
|
archetypes:
|
|
6
28
|
- kind: application-spec
|
|
7
29
|
name: Application Spec
|
|
@@ -24,25 +46,275 @@ artifact_types:
|
|
|
24
46
|
- name: ApplicationSpec
|
|
25
47
|
grammar_ref: app-spec
|
|
26
48
|
frontmatter_schema_ref: schemas/applicationspec-frontmatter.schema.json
|
|
49
|
+
data_schema:
|
|
50
|
+
schema: schemas/ApplicationSpec.json
|
|
51
|
+
digest: sha256:224936c23367cfa56a3d9554699ad69504ef1c50dcdcf49b36c7295f23ef58e1
|
|
27
52
|
defaults:
|
|
28
|
-
id_pattern:
|
|
53
|
+
id_pattern: AS-{next:03d}
|
|
29
54
|
allowed_links:
|
|
30
55
|
- contains
|
|
31
56
|
- depends_on
|
|
32
57
|
- references
|
|
33
58
|
examples: []
|
|
34
59
|
lint_rules_ref: []
|
|
60
|
+
# Every locator this ticket adds is optional except `title` and `purpose`,
|
|
61
|
+
# which every application spec authored before the change already carries
|
|
62
|
+
# (NFR-001 metric 3, FR-005-CON-1).
|
|
63
|
+
body_extraction:
|
|
64
|
+
yield_pattern:
|
|
65
|
+
match:
|
|
66
|
+
title:
|
|
67
|
+
from: heading
|
|
68
|
+
level: 1
|
|
69
|
+
required: true
|
|
70
|
+
assert:
|
|
71
|
+
level: 1
|
|
72
|
+
purpose:
|
|
73
|
+
from: section_body
|
|
74
|
+
after_heading: Purpose
|
|
75
|
+
required: true
|
|
76
|
+
assert:
|
|
77
|
+
level: 2
|
|
78
|
+
scope:
|
|
79
|
+
from: section_body
|
|
80
|
+
after_heading: Scope
|
|
81
|
+
required: false
|
|
82
|
+
assert:
|
|
83
|
+
level: 2
|
|
84
|
+
system_overview:
|
|
85
|
+
from: section_body
|
|
86
|
+
after_heading: System Overview
|
|
87
|
+
required: false
|
|
88
|
+
assert:
|
|
89
|
+
level: 2
|
|
90
|
+
structure:
|
|
91
|
+
from: section_body
|
|
92
|
+
after_heading: Structure
|
|
93
|
+
required: false
|
|
94
|
+
assert:
|
|
95
|
+
level: 2
|
|
96
|
+
requirements_architecture:
|
|
97
|
+
from: section_body
|
|
98
|
+
after_heading: Requirements Architecture
|
|
99
|
+
required: false
|
|
100
|
+
assert:
|
|
101
|
+
level: 2
|
|
102
|
+
references:
|
|
103
|
+
from: section_body
|
|
104
|
+
after_heading: References
|
|
105
|
+
required: false
|
|
106
|
+
assert:
|
|
107
|
+
level: 2
|
|
108
|
+
boundaries_table:
|
|
109
|
+
from: table_row
|
|
110
|
+
under_section: Boundaries
|
|
111
|
+
required: false
|
|
112
|
+
assert:
|
|
113
|
+
columns:
|
|
114
|
+
- ID
|
|
115
|
+
- Name
|
|
116
|
+
- Kind
|
|
117
|
+
- Description
|
|
118
|
+
min_rows: 1
|
|
119
|
+
id_column: ID
|
|
120
|
+
id_pattern: ^{id}-BND-\d+$
|
|
121
|
+
capabilities_table:
|
|
122
|
+
from: table_row
|
|
123
|
+
under_section: Capabilities
|
|
124
|
+
required: false
|
|
125
|
+
assert:
|
|
126
|
+
columns:
|
|
127
|
+
- ID
|
|
128
|
+
- Name
|
|
129
|
+
- Description
|
|
130
|
+
- Actors
|
|
131
|
+
min_rows: 1
|
|
132
|
+
id_column: ID
|
|
133
|
+
id_pattern: ^{id}-CAP-\d+$
|
|
134
|
+
actors_table:
|
|
135
|
+
from: table_row
|
|
136
|
+
under_section: Actors
|
|
137
|
+
required: false
|
|
138
|
+
assert:
|
|
139
|
+
columns:
|
|
140
|
+
- ID
|
|
141
|
+
- Name
|
|
142
|
+
- Kind
|
|
143
|
+
- Description
|
|
144
|
+
min_rows: 1
|
|
145
|
+
id_column: ID
|
|
146
|
+
id_pattern: ^{id}-ACT-\d+$
|
|
147
|
+
interfaces_table:
|
|
148
|
+
from: table_row
|
|
149
|
+
under_section: Interfaces
|
|
150
|
+
required: false
|
|
151
|
+
assert:
|
|
152
|
+
columns:
|
|
153
|
+
- ID
|
|
154
|
+
- Name
|
|
155
|
+
- Kind
|
|
156
|
+
- Direction
|
|
157
|
+
- Contract
|
|
158
|
+
min_rows: 1
|
|
159
|
+
id_column: ID
|
|
160
|
+
id_pattern: ^{id}-IFC-\d+$
|
|
161
|
+
data_dependencies_table:
|
|
162
|
+
from: table_row
|
|
163
|
+
under_section: Data Dependencies
|
|
164
|
+
required: false
|
|
165
|
+
assert:
|
|
166
|
+
columns:
|
|
167
|
+
- ID
|
|
168
|
+
- Name
|
|
169
|
+
- Source
|
|
170
|
+
- Access
|
|
171
|
+
min_rows: 1
|
|
172
|
+
id_column: ID
|
|
173
|
+
id_pattern: ^{id}-DAT-\d+$
|
|
174
|
+
rendering_requirements_table:
|
|
175
|
+
from: table_row
|
|
176
|
+
under_section: UI Rendering Requirements
|
|
177
|
+
required: false
|
|
178
|
+
assert:
|
|
179
|
+
columns:
|
|
180
|
+
- ID
|
|
181
|
+
- Surface
|
|
182
|
+
- Requirement
|
|
183
|
+
- Verification
|
|
184
|
+
min_rows: 1
|
|
185
|
+
id_column: ID
|
|
186
|
+
id_pattern: ^{id}-UI-\d+$
|
|
187
|
+
requirements_table:
|
|
188
|
+
from: table_row
|
|
189
|
+
under_section: Requirements
|
|
190
|
+
required: false
|
|
191
|
+
assert:
|
|
192
|
+
columns:
|
|
193
|
+
- ID
|
|
194
|
+
- Kind
|
|
195
|
+
- Source
|
|
196
|
+
- Target
|
|
197
|
+
min_rows: 1
|
|
198
|
+
id_column: ID
|
|
199
|
+
id_pattern: ^(StR|US|FR|NFR|IT|TC)-\d+$
|
|
200
|
+
properties_table:
|
|
201
|
+
from: table_row
|
|
202
|
+
under_section: Properties
|
|
203
|
+
required: false
|
|
204
|
+
assert:
|
|
205
|
+
columns:
|
|
206
|
+
- Field
|
|
207
|
+
- Type
|
|
208
|
+
- Multiplicity
|
|
209
|
+
- Constraints
|
|
210
|
+
min_rows: 1
|
|
211
|
+
properties_fence:
|
|
212
|
+
from: code_block
|
|
213
|
+
language: sysml
|
|
214
|
+
under_section: Properties
|
|
215
|
+
required: false
|
|
216
|
+
multiple: false
|
|
217
|
+
invariants:
|
|
218
|
+
from: code_block
|
|
219
|
+
language: ocl
|
|
220
|
+
under_section: Invariants
|
|
221
|
+
required: false
|
|
222
|
+
multiple: true
|
|
35
223
|
- name: MasterRequirements
|
|
36
224
|
grammar_ref: app-spec
|
|
37
225
|
frontmatter_schema_ref: schemas/masterrequirements-frontmatter.schema.json
|
|
226
|
+
data_schema:
|
|
227
|
+
schema: schemas/MasterRequirements.json
|
|
228
|
+
digest: sha256:82c627391b819e7517550c44e1564e0b6360816845f69fa20558d51ed2f38159
|
|
38
229
|
defaults:
|
|
39
|
-
id_pattern:
|
|
230
|
+
id_pattern: MR-{next:03d}
|
|
40
231
|
allowed_links:
|
|
41
232
|
- aggregates
|
|
42
233
|
- depends_on
|
|
43
234
|
- references
|
|
44
235
|
examples: []
|
|
45
236
|
lint_rules_ref: []
|
|
237
|
+
body_extraction:
|
|
238
|
+
yield_pattern:
|
|
239
|
+
match:
|
|
240
|
+
title:
|
|
241
|
+
from: heading
|
|
242
|
+
level: 1
|
|
243
|
+
required: true
|
|
244
|
+
assert:
|
|
245
|
+
level: 1
|
|
246
|
+
purpose:
|
|
247
|
+
from: section_body
|
|
248
|
+
after_heading: Purpose
|
|
249
|
+
required: true
|
|
250
|
+
assert:
|
|
251
|
+
level: 2
|
|
252
|
+
scope:
|
|
253
|
+
from: section_body
|
|
254
|
+
after_heading: Scope
|
|
255
|
+
required: false
|
|
256
|
+
assert:
|
|
257
|
+
level: 2
|
|
258
|
+
system_overview:
|
|
259
|
+
from: section_body
|
|
260
|
+
after_heading: System Overview
|
|
261
|
+
required: false
|
|
262
|
+
assert:
|
|
263
|
+
level: 2
|
|
264
|
+
structure:
|
|
265
|
+
from: section_body
|
|
266
|
+
after_heading: Structure
|
|
267
|
+
required: false
|
|
268
|
+
assert:
|
|
269
|
+
level: 2
|
|
270
|
+
requirements_architecture:
|
|
271
|
+
from: section_body
|
|
272
|
+
after_heading: Requirements Architecture
|
|
273
|
+
required: false
|
|
274
|
+
assert:
|
|
275
|
+
level: 2
|
|
276
|
+
references:
|
|
277
|
+
from: section_body
|
|
278
|
+
after_heading: References
|
|
279
|
+
required: false
|
|
280
|
+
assert:
|
|
281
|
+
level: 2
|
|
282
|
+
requirements_table:
|
|
283
|
+
from: table_row
|
|
284
|
+
under_section: Requirements
|
|
285
|
+
required: false
|
|
286
|
+
assert:
|
|
287
|
+
columns:
|
|
288
|
+
- ID
|
|
289
|
+
- Kind
|
|
290
|
+
- Source
|
|
291
|
+
- Target
|
|
292
|
+
min_rows: 1
|
|
293
|
+
id_column: ID
|
|
294
|
+
id_pattern: ^(StR|US|FR|NFR|IT|TC)-\d+$
|
|
295
|
+
properties_table:
|
|
296
|
+
from: table_row
|
|
297
|
+
under_section: Properties
|
|
298
|
+
required: false
|
|
299
|
+
assert:
|
|
300
|
+
columns:
|
|
301
|
+
- Field
|
|
302
|
+
- Type
|
|
303
|
+
- Multiplicity
|
|
304
|
+
- Constraints
|
|
305
|
+
min_rows: 1
|
|
306
|
+
properties_fence:
|
|
307
|
+
from: code_block
|
|
308
|
+
language: sysml
|
|
309
|
+
under_section: Properties
|
|
310
|
+
required: false
|
|
311
|
+
multiple: false
|
|
312
|
+
invariants:
|
|
313
|
+
from: code_block
|
|
314
|
+
language: ocl
|
|
315
|
+
under_section: Invariants
|
|
316
|
+
required: false
|
|
317
|
+
multiple: true
|
|
46
318
|
doc_kinds:
|
|
47
319
|
- application-spec
|
|
48
320
|
- master-requirements
|
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schemas.agent-ix.org/agent-ix/spec-artifacts-app/mappings.schema.json",
|
|
4
|
+
"title": "spec-artifacts-app Markdown mapping declaration",
|
|
5
|
+
"description": "The schema mappings.yaml validates against (FR-004). A malformed mapping is a schema error here rather than a reader's surprise.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"additionalProperties": false,
|
|
8
|
+
"required": [
|
|
9
|
+
"mapping_version",
|
|
10
|
+
"module",
|
|
11
|
+
"kinds",
|
|
12
|
+
"imported_types",
|
|
13
|
+
"models"
|
|
14
|
+
],
|
|
15
|
+
"properties": {
|
|
16
|
+
"mapping_version": {
|
|
17
|
+
"const": "1.0.0"
|
|
18
|
+
},
|
|
19
|
+
"module": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$"
|
|
22
|
+
},
|
|
23
|
+
"kinds": {
|
|
24
|
+
"description": "The mapping kinds this file uses; must equal the manifest's semantic.mappings list.",
|
|
25
|
+
"type": "array",
|
|
26
|
+
"minItems": 1,
|
|
27
|
+
"uniqueItems": true,
|
|
28
|
+
"items": {
|
|
29
|
+
"$ref": "#/$defs/kind"
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"imported_types": {
|
|
33
|
+
"description": "Types this module references from each package semantic.imports pins. FR-035 types `imports` as package -> exact semver and carries no type list (agent-ix/quoin#339), so the list lives here.",
|
|
34
|
+
"type": "object",
|
|
35
|
+
"propertyNames": {
|
|
36
|
+
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$"
|
|
37
|
+
},
|
|
38
|
+
"additionalProperties": {
|
|
39
|
+
"type": "array",
|
|
40
|
+
"minItems": 1,
|
|
41
|
+
"uniqueItems": true,
|
|
42
|
+
"items": {
|
|
43
|
+
"type": "string",
|
|
44
|
+
"pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"models": {
|
|
49
|
+
"type": "object",
|
|
50
|
+
"minProperties": 1,
|
|
51
|
+
"propertyNames": {
|
|
52
|
+
"pattern": "^[A-Z][A-Za-z0-9]*$"
|
|
53
|
+
},
|
|
54
|
+
"additionalProperties": {
|
|
55
|
+
"$ref": "#/$defs/model"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"$defs": {
|
|
60
|
+
"kind": {
|
|
61
|
+
"enum": [
|
|
62
|
+
"frontmatter",
|
|
63
|
+
"section",
|
|
64
|
+
"typed-table",
|
|
65
|
+
"sysml-fence",
|
|
66
|
+
"ocl-clause",
|
|
67
|
+
"provenance"
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
"model": {
|
|
71
|
+
"type": "object",
|
|
72
|
+
"additionalProperties": false,
|
|
73
|
+
"required": [
|
|
74
|
+
"schema",
|
|
75
|
+
"artifact_type",
|
|
76
|
+
"authority",
|
|
77
|
+
"round_trip",
|
|
78
|
+
"dropped_frontmatter_keys",
|
|
79
|
+
"properties"
|
|
80
|
+
],
|
|
81
|
+
"properties": {
|
|
82
|
+
"schema": {
|
|
83
|
+
"type": "string",
|
|
84
|
+
"pattern": "^schemas/[A-Za-z0-9]+\\.json$"
|
|
85
|
+
},
|
|
86
|
+
"artifact_type": {
|
|
87
|
+
"type": "string",
|
|
88
|
+
"minLength": 1
|
|
89
|
+
},
|
|
90
|
+
"authority": {
|
|
91
|
+
"const": "markdown"
|
|
92
|
+
},
|
|
93
|
+
"round_trip": {
|
|
94
|
+
"const": "derived"
|
|
95
|
+
},
|
|
96
|
+
"dropped_frontmatter_keys": {
|
|
97
|
+
"description": "Frontmatter keys the mapping drops. Declared so the loss is stated rather than silent; the emitted models are sealed, so an undeclared key cannot reach the record.",
|
|
98
|
+
"type": "array",
|
|
99
|
+
"uniqueItems": true,
|
|
100
|
+
"items": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"minLength": 1
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"properties": {
|
|
106
|
+
"type": "object",
|
|
107
|
+
"minProperties": 1,
|
|
108
|
+
"propertyNames": {
|
|
109
|
+
"pattern": "^[a-z][A-Za-z0-9]*$"
|
|
110
|
+
},
|
|
111
|
+
"additionalProperties": {
|
|
112
|
+
"$ref": "#/$defs/property"
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
},
|
|
117
|
+
"property": {
|
|
118
|
+
"type": "object",
|
|
119
|
+
"additionalProperties": false,
|
|
120
|
+
"required": [
|
|
121
|
+
"kind",
|
|
122
|
+
"lossless"
|
|
123
|
+
],
|
|
124
|
+
"properties": {
|
|
125
|
+
"kind": {
|
|
126
|
+
"$ref": "#/$defs/kind"
|
|
127
|
+
},
|
|
128
|
+
"lossless": {
|
|
129
|
+
"type": "boolean"
|
|
130
|
+
},
|
|
131
|
+
"required": {
|
|
132
|
+
"type": "boolean"
|
|
133
|
+
},
|
|
134
|
+
"prose_only": {
|
|
135
|
+
"description": "A structured section with no typed form. Requires a reason; the explicit designation FR-004-AC-2 demands.",
|
|
136
|
+
"type": "boolean"
|
|
137
|
+
},
|
|
138
|
+
"reason": {
|
|
139
|
+
"type": "string",
|
|
140
|
+
"minLength": 1
|
|
141
|
+
},
|
|
142
|
+
"locator": {
|
|
143
|
+
"type": "string",
|
|
144
|
+
"minLength": 1
|
|
145
|
+
},
|
|
146
|
+
"path": {
|
|
147
|
+
"type": "array",
|
|
148
|
+
"minItems": 1,
|
|
149
|
+
"items": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"minLength": 1
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"heading": {
|
|
155
|
+
"type": "string",
|
|
156
|
+
"minLength": 1
|
|
157
|
+
},
|
|
158
|
+
"columns": {
|
|
159
|
+
"type": "array",
|
|
160
|
+
"minItems": 1,
|
|
161
|
+
"items": {
|
|
162
|
+
"type": "string",
|
|
163
|
+
"minLength": 1
|
|
164
|
+
}
|
|
165
|
+
},
|
|
166
|
+
"row_model": {
|
|
167
|
+
"type": "string",
|
|
168
|
+
"minLength": 1
|
|
169
|
+
},
|
|
170
|
+
"id_pattern": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"minLength": 1
|
|
173
|
+
},
|
|
174
|
+
"language": {
|
|
175
|
+
"type": "string",
|
|
176
|
+
"minLength": 1
|
|
177
|
+
},
|
|
178
|
+
"cell_parses": {
|
|
179
|
+
"type": "object",
|
|
180
|
+
"propertyNames": {
|
|
181
|
+
"pattern": "^[A-Za-z][A-Za-z0-9 ]*$"
|
|
182
|
+
},
|
|
183
|
+
"additionalProperties": {
|
|
184
|
+
"enum": [
|
|
185
|
+
"id",
|
|
186
|
+
"verification",
|
|
187
|
+
"imported-type-ref",
|
|
188
|
+
"id-list",
|
|
189
|
+
"enum",
|
|
190
|
+
"text",
|
|
191
|
+
"multiplicity",
|
|
192
|
+
"constraints"
|
|
193
|
+
]
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
"alternate_form": {
|
|
197
|
+
"description": "The same declarations authored another way. One artifact carries one form; the alternate is a separate file.",
|
|
198
|
+
"type": "object",
|
|
199
|
+
"additionalProperties": false,
|
|
200
|
+
"required": [
|
|
201
|
+
"kind",
|
|
202
|
+
"heading",
|
|
203
|
+
"language"
|
|
204
|
+
],
|
|
205
|
+
"properties": {
|
|
206
|
+
"kind": {
|
|
207
|
+
"$ref": "#/$defs/kind"
|
|
208
|
+
},
|
|
209
|
+
"heading": {
|
|
210
|
+
"type": "string",
|
|
211
|
+
"minLength": 1
|
|
212
|
+
},
|
|
213
|
+
"language": {
|
|
214
|
+
"type": "string",
|
|
215
|
+
"minLength": 1
|
|
216
|
+
},
|
|
217
|
+
"locator": {
|
|
218
|
+
"type": "string",
|
|
219
|
+
"minLength": 1
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"allOf": [
|
|
225
|
+
{
|
|
226
|
+
"if": {
|
|
227
|
+
"properties": {
|
|
228
|
+
"prose_only": {
|
|
229
|
+
"const": true
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
"required": [
|
|
233
|
+
"prose_only"
|
|
234
|
+
]
|
|
235
|
+
},
|
|
236
|
+
"then": {
|
|
237
|
+
"required": [
|
|
238
|
+
"reason"
|
|
239
|
+
]
|
|
240
|
+
}
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"if": {
|
|
244
|
+
"properties": {
|
|
245
|
+
"kind": {
|
|
246
|
+
"const": "typed-table"
|
|
247
|
+
}
|
|
248
|
+
},
|
|
249
|
+
"required": [
|
|
250
|
+
"kind"
|
|
251
|
+
]
|
|
252
|
+
},
|
|
253
|
+
"then": {
|
|
254
|
+
"required": [
|
|
255
|
+
"heading",
|
|
256
|
+
"columns",
|
|
257
|
+
"locator"
|
|
258
|
+
]
|
|
259
|
+
}
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"if": {
|
|
263
|
+
"properties": {
|
|
264
|
+
"kind": {
|
|
265
|
+
"const": "section"
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
"required": [
|
|
269
|
+
"kind"
|
|
270
|
+
]
|
|
271
|
+
},
|
|
272
|
+
"then": {
|
|
273
|
+
"required": [
|
|
274
|
+
"heading",
|
|
275
|
+
"locator"
|
|
276
|
+
]
|
|
277
|
+
}
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"if": {
|
|
281
|
+
"properties": {
|
|
282
|
+
"kind": {
|
|
283
|
+
"const": "frontmatter"
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"required": [
|
|
287
|
+
"kind"
|
|
288
|
+
]
|
|
289
|
+
},
|
|
290
|
+
"then": {
|
|
291
|
+
"required": [
|
|
292
|
+
"path"
|
|
293
|
+
]
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
"if": {
|
|
298
|
+
"properties": {
|
|
299
|
+
"kind": {
|
|
300
|
+
"const": "ocl-clause"
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"required": [
|
|
304
|
+
"kind"
|
|
305
|
+
]
|
|
306
|
+
},
|
|
307
|
+
"then": {
|
|
308
|
+
"required": [
|
|
309
|
+
"heading",
|
|
310
|
+
"language",
|
|
311
|
+
"locator"
|
|
312
|
+
]
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
]
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|