Skip to content

Commit 33c9df1

Browse files
committed
feat: update express changes with how to specify schemas
1 parent 933989d commit 33c9df1

7 files changed

Lines changed: 38 additions & 21 deletions

File tree

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/schema_changes.yaml
22
---
33
schema: Document_and_version_identification_arm
4-
editions:
5-
- version: '2'
6-
- version: '3'
4+
versions:
5+
- version: 2
6+
- version: 3
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/mapping_changes.yaml
22
---
33
schema: dimension_tolerance
4-
editions:
5-
- version: '6'
4+
versions:
5+
- version: 6
66
mappings:
77
- description: Geometric_dimension entity and attributes mapping has been updated
88
- description: Angle_plus_minus_bounds and Length_plus_minus_bounds mappings was
99
added
10-
- version: '7'
10+
- version: 7
1111
mappings:
1212
- description: Angle_plus_minus_bounds mapping has been updated
1313
- description: Length_plus_minus_bounds mapping has been updated
1414
- description: Applied_activity_assignment ENTITY mapped
15-
- version: '8'
15+
- version: 8
1616
mappings:
1717
- description: Geometric_dimension entity and attributes mapping has been updated

sources/express-changes/examples/mim.changes.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/schema_changes.yaml
22
---
33
schema: Document_and_version_identification_mim
4-
editions:
5-
- version: '2'
4+
versions:
5+
- version: 2
66
deletions:
77
- type: USE_FROM
88
name: Product_identification_mim
9-
- version: '3'
9+
- version: 3
1010
additions:
1111
- type: USE_FROM
1212
name: product_definition_schema

sources/express-changes/examples/support_resource_schema.changes.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/schema_changes.yaml
22
---
33
schema: support_resource_schema
4-
editions:
5-
- version: '2'
4+
versions:
5+
- version: 2
66
description: |-
77
The definitions of the following EXPRESS entity data types were modified:
88
@@ -15,7 +15,7 @@ editions:
1515
modifications:
1616
- type: FUNCTION
1717
name: bag_to_set
18-
- version: '4'
18+
- version: 4
1919
description: |-
2020
The following entity types had been introduced to support external element references outside the local population of entity instances:
2121

sources/express-changes/schemas/schema_changes.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ definitions:
4141
description: Array of modified elements
4242
items:
4343
$ref: '#/definitions/item_change'
44-
removals:
44+
deletions:
4545
type: array
46-
description: Array of removed elements
46+
description: Array of deleted elements
4747
items:
4848
$ref: '#/definitions/item_change'
4949
item_change:

sources/express-changes/sections/aa-examples.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
=== General
55

6-
This annex provides example of the EXPRESS Changes YAML format.
6+
This annex provides examples of the EXPRESS Changes YAML format.
77

88
=== Schema change
99

sources/express-changes/sections/ab-schemas.adoc

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,49 @@
33

44
=== General
55

6-
This annex provides the JSON Schema definitions for the EXPRESS Changes YAML
6+
This annex provides the YAML Schema definitions for the EXPRESS Changes YAML
77
formats defined in this document.
88

99
These schemas can be used to validate EXPRESS Changes YAML files and to
1010
generate documentation or tooling for working with EXPRESS change records.
1111

12+
The schemas are defined in YAML Schema format that follows the JSON Schema
13+
format (draft-07).
14+
15+
1216
=== Schema change schema
1317

1418
The schema change schema defines the structure for recording modifications to
1519
EXPRESS schema structure across versions, as described in <<schema-change>>.
1620

17-
The schema is defined in JSON Schema format (draft-07).
18-
1921
[source,yaml]
2022
----
2123
include::../schemas/schema_changes.yaml[]
2224
----
2325

26+
This schema can be used for validation by prefixing an EXPRESS Changes YAML
27+
file with the following comment line:
28+
29+
[source,yaml]
30+
----
31+
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/schema_changes.yaml
32+
----
33+
2434
=== Mapping change schema
2535

2636
The mapping change schema defines the structure for recording modifications to
2737
EXPRESS schema mappings across versions, as described in <<mapping-change>>.
2838

29-
The schema is defined in JSON Schema format (draft-07).
30-
3139
[source,yaml]
3240
----
3341
include::../schemas/mapping_changes.yaml[]
3442
----
43+
44+
This schema can be used for validation by prefixing an EXPRESS Changes YAML
45+
file with the following comment line:
46+
47+
[source,yaml]
48+
----
49+
# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/mapping_changes.yaml
50+
----
51+

0 commit comments

Comments
 (0)