-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://gitlab.com/libremfg/b2mml-batchml
- Loading branch information
Showing
60 changed files
with
57,548 additions
and
14 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,4 +1,6 @@ | ||
./Docs/static/schemas/*.json | ||
/Docs/public/ | ||
.hugo_build.lock | ||
Examples/ | ||
Examples/ | ||
node_modules/ | ||
.DS_Store |
This file contains 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 contains 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 contains 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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
+++ | ||
title = 'Version v1.0.0' | ||
title = 'Version 1.0.0' | ||
date = 2024-07-12T18:43:31Z | ||
+++ | ||
|
||
|
This file contains 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,60 @@ | ||
+++ | ||
title = 'Version 2.0.0' | ||
date = 2024-09-20T14:52:37-05:00 | ||
+++ | ||
|
||
> A JSON Schema implementation of the ANSI/ISA-95 and ANSI/ISA-88 standards. | ||
An JSON implementation of the ANSI/ISA-95, Enterprise-Control System Integration, family of standards (ISA-95), known internationally as IEC/ISO 62264. B2MML consists of a set of JSON schemas written using the JSON Schema's Schema language (2020) that implement the data models in the ISA-95 standard. | ||
|
||
This JSON schema can be used for design for syncrhonous and asynchronous APIs. | ||
|
||
Based on the works of https://github.com/MESAInternational/B2MML-BatchML. | ||
|
||
## Abbreviations | ||
|
||
| Acronynm | Description | | ||
|-------------|---------------------------------------------------------------| | ||
| **ANSI** | American National Standards Institute | | ||
| **API** | Application Programming Interface | | ||
| **B2MML** | Business to (2) Manufacturing Markup Language | | ||
| **BatchML** | Batch Markup Language | | ||
| **BOD** | Business Object Document | | ||
| **ISA** | International Society of Automation | | ||
| **IEC** | International Electrotechnical Commission | | ||
| **JSON** | JavaScipt Object Notation | | ||
| **XML** | eXensible Markup Language | | ||
| **XSD** | eXtensible markup language Schema Definition | | ||
|
||
## Quick start | ||
|
||
Start out by importing the schema and using it in your JSON documents. | ||
|
||
``` | ||
"$schema": "{{< siteurl >}}schemas/" | ||
``` | ||
|
||
Here is an example using the JSON schema in a `NotifyWorkDefined` message. | ||
|
||
```json | ||
{ | ||
"$schema": "{{< siteurl >}}schemas/", | ||
"NotifyWorkDefined": { | ||
"ApplicationArea": {}, | ||
"DataArea": { | ||
"Notify": {}, | ||
"WorkDefined": { | ||
|
||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Updates Introduced in Version 2.0.0 | ||
|
||
Refactored the v1.0.0.base.schema.json JSON file by separating it into multiple files that use the prefix "v2.0.0", aligning the structure with the existing B2MMl XML implementation https://github.com/MESAInternational/B2MML-BatchML/tree/master/Schema. | ||
|
||
Implemented several automated scripts to assist in refactoring. While these scripts are tailored for specific use cases, they can generally be disregarded outside of those particular scenarios. | ||
|
||
In Version 2.0.0, a JSON Schema validator is used for verification, replacing the previous Lint-based approach. This update compiles and validates schemas through the use of scripts, specifically compileSchemas.js, located in scripts, and validate.mjs. |
This file contains 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,3 @@ | ||
module validator | ||
|
||
go 1.22.2 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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,7 @@ | ||
{ | ||
"dependencies": { | ||
"ajv": "^8.17.1", | ||
"ajv-formats": "^3.0.1" | ||
}, | ||
"version": "0.0.0" | ||
} |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.