Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.abort
Gemfile.lock
*.log.*
*.err
relaton/
iev/
_site/
10 changes: 8 additions & 2 deletions sources/express-changes/document.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:docnumber: 5005
:edition: 1
:copyright-year: 2025
:revdate: 2025-02-06
:revdate: 2025-10-14
:language: en
:title-main-en: EXPRESS changes model in YAML
:doctype: standard
Expand Down Expand Up @@ -32,6 +32,12 @@ include::sections/02-normrefs.adoc[]

include::sections/03-terms.adoc[]

include::sections/04-spec.adoc[]
include::sections/04-structure.adoc[]

include::sections/05-schema-change.adoc[]

include::sections/06-mapping-change.adoc[]

include::sections/aa-examples.adoc[]

include::sections/az-bibliography.adoc[]
47 changes: 47 additions & 0 deletions sources/express-changes/schemas/mapping_changes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
$schema: http://json-schema.org/draft-07/schema#
title: EXPRESS Mapping Changes
description: Records modifications to EXPRESS schema mappings across editions
type: object
required:
- schema
- editions
properties:
schema:
type: string
description: Name of the EXPRESS schema
editions:
type: array
description: Array of edition changes
items:
$ref: '#/definitions/edition_change'
definitions:
edition_change:
type: object
description: Changes made to the mapping specification in a specific edition
required:
- version
properties:
version:
type: string
description: Version number for this change edition
pattern: '^[1-9][0-9]*$'
description:
type: string
description: >-
Multi-line string describing the changes made in this edition.
Provides comprehensive overview of what changed and why.
mappings:
type: array
description: Array of mapping changes
items:
$ref: '#/definitions/mapping_change'
mapping_change:
type: object
description: Represents a specific element whose mapping has changed
properties:
name:
type: string
description: Name of the EXPRESS construct whose mapping changed
description:
type: string
description: Description of the mapping change
83 changes: 83 additions & 0 deletions sources/express-changes/schemas/schema_changes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
$schema: http://json-schema.org/draft-07/schema#
title: EXPRESS Schema Changes
description: Records modifications to EXPRESS schema structure across editions
type: object
required:
- schema
- editions
properties:
schema:
type: string
description: Name of the EXPRESS schema
editions:
type: array
description: Array of edition changes
items:
$ref: '#/definitions/edition_change'
definitions:
edition_change:
type: object
description: Changes made to the schema in a specific edition
required:
- version
properties:
version:
type: string
description: Version number for this change edition
pattern: '^[1-9][0-9]*$'
description:
type: string
description: >-
Multi-line string describing the changes made in this edition.
Provides comprehensive overview of what changed and why.
additions:
type: array
description: Array of added elements
items:
$ref: '#/definitions/item_change'
modifications:
type: array
description: Array of modified elements
items:
$ref: '#/definitions/item_change'
removals:
type: array
description: Array of removed elements
items:
$ref: '#/definitions/item_change'
item_change:
type: object
description: Represents a specific schema element change
required:
- type
- name
properties:
type:
type: string
description: Type of the EXPRESS construct
enum:
- ENTITY
- TYPE
- FUNCTION
- RULE
- PROCEDURE
- CONSTANT
- REFERENCE_FROM
- USE_FROM
name:
type: string
description: Name of the EXPRESS construct
description:
type: array
description: >-
Array of strings describing the change. Each string represents
a description for a single change in the named target.
items:
type: string
interfaced_items:
type: array
description: >-
For USE_FROM or REFERENCE_FROM, list of specific items referenced
or used. Not needed when in deletions.
items:
type: string
105 changes: 0 additions & 105 deletions sources/express-changes/sections/04-spec.adoc

This file was deleted.

40 changes: 40 additions & 0 deletions sources/express-changes/sections/04-structure.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
== Structure

An EXPRESS Changes document is a YAML file that records changes made to an
EXPRESS schema across different editions or versions.

There are two kinds of changes:

* Schema changes
* Mapping changes

The top-level structure of an EXPRESS Changes document has the following
specification.

[source,yaml]
----
schema: String (required)
# Name of the EXPRESS schema
editions:
- version: String (required)
# Version number for this change edition
description: String (optional)
# Description of changes in this edition
{type_of_change}:
- description: String (required)
# Description of the change
# ... additional fields depending on type_of_change
----

Fields:

`schema`:: The name of the EXPRESS schema (string) (required).
+
[example]
`support_resource_schema`

`editions`:: An array of edition change objects (required).

`type_of_change`:: One of `additions`, `modifications`, `removals`, or
`mapping`.

Loading