-
Notifications
You must be signed in to change notification settings - Fork 0
feat: update changes yaml spec for latest ISO 10303 #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
aaa3831
feat: update changes yaml spec for latest ISO 10303
ronaldtse 1b74872
feat: update content per @TRThurman and make interfaced_items and des…
ronaldtse 53e17b2
chore: add gitignore
ronaldtse 4779e56
feat: add YAML schemas for schema changes and mapping changes
ronaldtse File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 (required) | ||
| # 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`. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
|
|
||
| == Schema change | ||
|
|
||
| === General | ||
|
|
||
| The schema change structure captures modifications to the structure and | ||
|
ronaldtse marked this conversation as resolved.
Outdated
|
||
| semantics of an EXPRESS schema across different editions or versions. It | ||
| captures additions, modifications, and removals of schema elements such as | ||
| entities, types, functions, and rules. | ||
|
|
||
| The structure is built on the following constructs: | ||
|
|
||
| * Edition changes: Each edition or version of the schema, detailing what | ||
| changed. | ||
|
|
||
| * Item changes: Specific elements that were added, modified, or removed in an | ||
| edition. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| schema: String (required) | ||
| # Name of the EXPRESS schema | ||
| editions: | ||
| - {edition change 1} | ||
| - {edition change 2} | ||
| ---- | ||
|
|
||
|
|
||
| === Edition change | ||
|
|
||
| Each edition change represents a specific version of the schema and details | ||
| the changes made in that version. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| version: String (required) | ||
| # Version number for this change edition | ||
| description: String (required) | ||
| # Description of changes in this edition | ||
| additions: | ||
| - {item change 1} | ||
| - {item change 2} | ||
| modifications: | ||
| - {item change 1} | ||
| - {item change 2} | ||
| removals: | ||
| - {item change 1} | ||
| - {item change 2} | ||
| ---- | ||
|
|
||
| Fields: | ||
|
|
||
| `version`:: The version number (string) (required). | ||
| + | ||
|
ronaldtse marked this conversation as resolved.
|
||
| [example] | ||
| `2`, `3.1`, `2024-06`. | ||
|
|
||
| `description`:: A multi-line string describing the changes made in this edition | ||
| (required). Should provide a comprehensive overview of what changed and why. | ||
|
|
||
| `additions`:: An array of added elements as item changes (optional). | ||
|
|
||
| `modifications`:: An array of modified elements as item changes (optional). | ||
|
|
||
| `removals`:: An array of removed elements as item changes (optional). | ||
|
|
||
|
|
||
|
|
||
| === Item change | ||
|
|
||
| Each item change represents a specific schema element that was added, modified, | ||
| or removed. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| type: String (required) | ||
| # Type of the EXPRESS construct (e.g., ENTITY, TYPE, FUNCTION) | ||
| name: String (required) | ||
| # Name of the EXPRESS construct | ||
| ---- | ||
|
|
||
| Fields: | ||
|
|
||
| `type`:: The type of the EXPRESS construct (string) (required). Allowed values | ||
| are: | ||
|
|
||
|
ronaldtse marked this conversation as resolved.
|
||
| `ENTITY`::: Entity definitions | ||
| `TYPE`::: Type definitions (including SELECT, ENUMERATION) | ||
| `FUNCTION`::: Function definitions | ||
| `RULE`::: Rule definitions | ||
| `PROCEDURE`::: Procedure definitions | ||
| `CONSTANT`::: Constant definitions | ||
|
|
||
| `name`:: The name of the EXPRESS construct (string) (required). | ||
|
|
||
104 changes: 104 additions & 0 deletions
104
sources/express-changes/sections/06-mapping-change.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| == Mapping change | ||
|
|
||
| === General | ||
|
|
||
|
|
||
| A mapping change records modifications to the mapping of an EXPRESS schema to | ||
| another schema or representation. | ||
|
|
||
| The structure is built on the following constructs: | ||
|
|
||
| * Edition changes: Each edition or version of the schema, detailing what | ||
|
ronaldtse marked this conversation as resolved.
Outdated
|
||
| changed. | ||
|
|
||
| * Item changes: Specific elements that had mappings changed in an edition. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| schema: String (required) | ||
| # Name of the EXPRESS schema | ||
| editions: | ||
| - {edition change 1} | ||
| - {edition change 2} | ||
| ---- | ||
|
|
||
| === Edition change | ||
|
|
||
| Each edition change represents a specific version of the schema and details | ||
|
ronaldtse marked this conversation as resolved.
Outdated
|
||
| the mapping changes made in that version. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| version: String (required) | ||
| # Version number for this change edition | ||
| description: String (required) | ||
| # Description of changes in this edition | ||
| mapping: | ||
| - {item change 1} | ||
| - {item change 2} | ||
| ---- | ||
|
|
||
| Fields: | ||
|
|
||
| `version`:: The version number (string) (required). | ||
| + | ||
|
ronaldtse marked this conversation as resolved.
|
||
| [example] | ||
| `2`, `3.1`, `2024-06`. | ||
|
|
||
| `description`:: A multi-line string describing the changes made in this edition | ||
| (required). Should provide a comprehensive overview of what changed and why. | ||
|
ronaldtse marked this conversation as resolved.
Outdated
|
||
|
|
||
| `mappings`:: An array of mapping changes (optional). | ||
|
|
||
|
|
||
| === Mapping change | ||
|
|
||
| Each mapping change represents a specific element whose mapping has changed in an | ||
| edition. | ||
|
|
||
| Syntax: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| name: String (required) | ||
| # Name of the EXPRESS construct whose mapping changed | ||
| description: String (optional) | ||
| # Description of the mapping change | ||
| ---- | ||
|
|
||
| Fields: | ||
|
|
||
| `name`:: The name of the EXPRESS construct whose mapping changed (string) (required). | ||
|
|
||
| `description`:: A description of the mapping change (string) (optional). | ||
|
|
||
|
|
||
| .Mapping change file from ISO 10303 SRL altered_package | ||
| [example] | ||
| ==== | ||
| [source,yaml] | ||
| ---- | ||
| --- | ||
| schema: altered_package | ||
| change_edition: | ||
| - version: '2' | ||
| mappings: | ||
| - name: Altered_package.modified_terminal_separation | ||
| - description: Altered_package.of_geometric_status mapping has been updated. | ||
| - version: '3' | ||
| description: |- | ||
| Minor editorial changes. | ||
|
|
||
| The definitions of the following MIM EXPRESS declarations and interface specifications were modified: | ||
|
|
||
| * ENTITY surface_prepped_terminal. | ||
| - version: '4' | ||
| description: 'Minor editorial change: the HTML link of Layered_assembly_module_design_view | ||
| in Surface_prepped_terminal''s description has been fixed.' | ||
| ---- | ||
| ==== | ||
|
|
||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.