Skip to content

Fix v2.0.0 documentation examples #3

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.

Sign up for GitHub

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 2 commits into from
Dec 5, 2024
Merged

Fix v2.0.0 documentation examples #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a9ed6c
Fix examples
Dec 5, 2024
34d6df9
Merge pull request #2 from libremfg/fix/examples
tomhollingworth Dec 5, 2024
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
40 changes: 29 additions & 11 deletions Docs/content/posts/version-v2.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,36 @@ Based on the works of https://github.com/MESAInternational/B2MML-BatchML.

## Quick start

Start out by importing the schema and using it in your JSON documents.
Start out by importing the schema and using it in your JSON documents. As an example:

```
"$schema": "{{< siteurl >}}schemas/"
"$schema": "{{< siteurl >}}schemas/v2.0.0.equipment.schema.json"
```

Here is an example using the JSON schema in a `NotifyWorkDefined` message.
Here is an example using the JSON schema in a `ProcessEquipment` message.

```json
{
"$schema": "{{< siteurl >}}schemas/",
"NotifyWorkDefined": {
"ApplicationArea": {},
"DataArea": {
"Notify": {},
"WorkDefined": {

"$schema": "https://json.libremfg.ai/schemas/v2.0.0.equipment.schema.json",
"ProcessEquipment": {
"@releaseID": "1",
"ApplicationArea": {
"CreationDateTime": "2021-01-01T00:00:00Z",
"Sender": {
"LogicalID": "Rhize Manufacutring Data Hub"
}
},
"DataArea": {
"Process": {},
"Equipment": [
{
"ID": "Acme Inc.",
"Description": [
"Acme Inc. Manufacturing Line 1"
],
"EquipmentLevel": "Enterprise"
}
]
}
}
}
Expand All @@ -57,4 +69,10 @@ Refactored the v1.0.0.base.schema.json JSON file by separating it into multiple

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.
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.

## Object Schema File Table

Use the search functionality of your browser to find an object of interet.

{{< table/propertiesV200 >}}
Loading
Loading