Skip to content

Commit 6fdc62f

Browse files
authored
add documentation on handling of external references (#898)
1 parent 85f9db7 commit 6fdc62f

5 files changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,12 @@ Explore how to use MetaConfigurator with real-world examples:
9999

100100
* **[Code Generation](./documentation_user/examples/code_generation)** – Learn how to generate code in multiple programming languages from JSON schemas.
101101

102+
* **[Schema Selection List](./documentation_user/examples/schema_selection_list)** – Learn how to provide your users with a pre-defined list of schemas to choose from; useful for organizations.
103+
102104
* **[AI Assistance](./documentation_user/examples/ai_assistance)** – Learn how to use AI-assisted features for schema and data creation/editing, as well as data transformation.
103105

106+
* **[External References](./documentation_user/examples/external_references)** – Learn how to handle external references in MetaConfigurator.
107+
104108

105109

106110
📚 Read the full [User Documentation](./documentation_user).

documentation_user/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Code Generation](examples/code_generation) (Shows how to generate code in multiple programming languages from JSON schemas)
88
* [Schema Selection List](examples/schema_selection_list) (Provide your users a pre-defined list of schemas to choose from; useful for organizations)
99
* [AI Assistance](examples/ai_assistance) (Shows how to use AI-assisted features for schema and data creation/editing, as well as data transformation)
10+
* [External References](examples/external_references) (Shows how to handle external references in MetaConfigurator)
1011

1112
## Load a Schema
1213

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Handling external references in MetaConfigurator
2+
================================================
3+
4+
While MetaConfigurator primarily focuses on the local JSON schema and data files, it provides basic support for external references.
5+
External references allow you to include content from other files or URLs into your schema or data, enabling modularity and reuse.
6+
7+
Currently, the data tab and validation by default ignore external references, but the schema tab provides options to resolve all or some external references or bundle all content within the same schema with one click.
8+
Once resolved, also the data tab and validation will take the content of the reference into account, as it is now part of the schema.
9+
10+
Resolving References in the Schema Tab
11+
--------------------------------------
12+
13+
In the menu bar of the schema tab, there is a set of `utility` options for resolving all references or bundling a whole schema, as well as an inverse option (extract all inlined schema elements into definitions and replace them with references).
14+
15+
![Reference Utilities](./ref_utility.png)
16+
17+
Furthermore, the schema diagram visualizes external references as nodes with a blue color frame and provides a button to resolve the reference directly in the diagram.
18+
19+
![Reference in Diagram](./ref_diagram.png)
54.5 KB
Loading
71.4 KB
Loading

0 commit comments

Comments
 (0)