yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-18 14:06:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [main] 68 pages modified

Browse Source
This commit is contained in:
Suresh Srinivas 2021-08-13 20:12:38 +00:00 committed by gitbook-bot
parent abf74c34f2
commit d5ec35590d
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
5 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -4,7 +4,7 @@ Data is an important asset of an organization and metadata is the key to unlock
Poorly organized metadata is preventing organizations from realizing the full potential of data. Metadata is incorrect, inconsistent, stale, often missing, and fragmented in silos across various disconnected tools in proprietary formats obscuring a holistic picture of data.
**OpenMetadata is an Open standard for metadata with a centralized metadata store that unifies all the data assets and metadata end-to-end to power data discovery, user collaboration, and tool interoperability.**
## **OpenMetadata is an Open standard for metadata with a centralized metadata store that unifies all the data assets and metadata end-to-end to power data discovery, user collaboration, and tool interoperability.**
![](.gitbook/assets/openmetadata-overview.png)

3
docs/SUMMARY.md
View File

@ -6,7 +6,8 @@
## OpenMetadata APIs
* [Schemas](openmetadata-apis/schemas/README.md)
* [Overview](openmetadata-apis/schemas/overview.md)
* [Schema Language](openmetadata-apis/schemas/schema-language.md)
* [Schema Concepts](openmetadata-apis/schemas/overview.md)
* [OpenMetadata Types](openmetadata-apis/schemas/types/README.md)
* [Basic](openmetadata-apis/schemas/types/basic.md)
* [Audit Log](openmetadata-apis/schemas/types/audit-log.md)

16
docs/openmetadata-apis/schemas/README.md
View File

@ -2,19 +2,7 @@
## Schema Modeling
OpenMetadata takes the **schema-first** approach to model metadata as a Single Source of Truth with clear vocabulary for the system. First, the Entities, Types, and relationships between the entities in the system are identified and schemas are defined for them. Code is then generated from these schemas for implementation. We use [JSON schema](https://json-schema.org/) as the Schema Definition Language as it offers several advantages:
* Easy to describe the structure and semantics of metadata models with readable documentation that is both human and machine consumable.
* Common types can be developed once and can be reused as building blocks in other schemas and become the basis of vocabulary development.
* Models can include structural validation, such as required/optional fields, default values, allowed values, regex that not only serve as automated testing and validation but also as documentation of API contract.
* A rich set of tools are available that supports JSON schema support for generating code and validation from JSON schema in various languages, reducing the manual boilerplate coding.
* Supports rich formats to convert schema types into native standard types during code generation, such as URI, date, and time.
## Reference
1. [JSON schema](https://json-schema.org/) specification version [Draft-07 to 2019-099](https://json-schema.org/draft/2019-09/release-notes.html)
2. [JSON schema 2 POJO](https://www.jsonschema2pojo.org/) tool used for Java code generation from JSON schema
3. [Data model code generator](https://github.com/koxudaxi/datamodel-code-generator) for generating python code from JSON schema
OpenMetadata takes the **schema-first** approach to model metadata as a Single Source of Truth with clear vocabulary for the system. First, the Entities, Types, and relationships between the entities in the system are identified and schemas are defined for them. Code is then generated from these schemas for implementation.
## Schemas
@ -22,7 +10,5 @@ OpenMetadata takes the **schema-first** approach to model metadata as a Single S
{% page-ref page="types/" %}
## Version Note
The schemas linked above follow the JSON Schema Spec version: [http://json-schema.org/draft-07/schema\#](http://json-schema.org/draft-07/schema#)

2
docs/openmetadata-apis/schemas/overview.md
View File

@ -1,4 +1,4 @@
# Overview
# Schema Concepts
## Types

18
docs/openmetadata-apis/schemas/schema-language.md Normal file
View File

@ -0,0 +1,18 @@
# Schema Language
We use [JSON schema](https://json-schema.org/) as the Schema Definition Language as it offers several advantages:
* Easy to describe the structure and semantics of metadata models with readable documentation that is both human and machine consumable.
* Common types can be developed once and can be reused as building blocks in other schemas and become the basis of vocabulary development.
* Models can include structural validation, such as required/optional fields, default values, allowed values, regex that not only serve as automated testing and validation but also as documentation of API contract.
* A rich set of tools are available that supports JSON schema support for generating code and validation from JSON schema in various languages, reducing the manual boilerplate coding.
* Supports rich formats to convert schema types into native standard types during code generation, such as URI, date, and time.
## Reference
1. [JSON schema](https://json-schema.org/) specification version [Draft-07 to 2019-099](https://json-schema.org/draft/2019-09/release-notes.html)
2. [JSON schema 2 POJO](https://www.jsonschema2pojo.org/) tool used for Java code generation from JSON schema
3. [Data model code generator](https://github.com/koxudaxi/datamodel-code-generator) for generating python code from JSON schema
##