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

shahsank3t published a site update

Browse Source
This commit is contained in:
shahsank3t 2021-08-04 12:40:55 +00:00
parent d53bae2e6e
commit b59c4974a5
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,4 +24,4 @@ OpenMetadata takes the **schema-first** approach to model metadata as a Single S
## Version Note
The schemas linked above follow the JSON Schema Spec version:
The schemas linked above follow the JSON Schema Spec version: http://json-schema.org/draft-07/schema#

8
docs/openmetadata-apis/schemas/entities/README.md
View File

@ -8,12 +8,12 @@ An Entity is a special type that has an identity and represents an object that i
| Abstract | Extensible |
| :--- | :--- |
| **id** | Mandatory attribute of type that identifies the entity instance |
| **id** | Mandatory attribute of type UUID that identifies the entity instance |
| **name** | Name of the entity \(example database name\). For some entities, the name may uniquely identify an entity. |
| **fullyQualifiedName** | Human-readable name that uniquely identifies an entity that is formed using all the names in the hierarchy above the given entity. Example - Attributes of an entity may also have to uniquely identify a field. For example, a column of a table has attribute set to |
| **displayName** | Optional name used for display purposes. For example, the name could be and could be |
| **displayName** | Optional name used for display purposes. For example, the name could be john.smith@domain.com and displayName could be John Smith. |
| **description** | Description of the entity instance. Not all entities need a description. For example, a User entity might not need a description and just the name of the user might suffice. A entity needs to provide details of what is stored in the database when to use it and other information on how to use it. |
| **Owner** | Optional attribute used to capture the ownership information. Not all entities have ownership information \(for example , and \). |
| **Owner** | Optional attribute used to capture the ownership information. Not all entities have ownership information \(for example User, Team, and Organization). |
| **href** | An attribute generated on the fly as part of API response to provide the URL link to the entity returned. |
### **Relationships**
@ -24,7 +24,7 @@ An Entity is a special type that has an identity and represents an object that i
* One to Many: a Database contains multiple Tables.
* Many-to-Many: A User belongs to multiple Teams. A team has multiple Users.
All relationships are captured using the type.
All relationships are captured using the EntityReference type.
Following is an example of a JSON schema of the User entity with attributes id, displayName, and email. User entity has one-to-many relationships to another entity Team \(user is member of multiple teams\).: is a special shell builtin
string: not found

2
docs/openmetadata-apis/schemas/types/README.md
View File

@ -1,6 +1,6 @@
# Types
JSON schema supports many native types - and . In addition, to develop clear and consistent vocabulary, domain-specific reusable types are defined ranging from simple types, such as , , and to more complex object types, such as and .
JSON schema supports many native types - null, boolean, object, array, number and string. In addition, to develop clear and consistent vocabulary, domain-specific reusable types are defined ranging from simple types, such as UUID, timestamp, and email to more complex object types, such as Tags, Ownership and Usage.
## List of Schema Types