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

minor changes in scripts (#46)

Browse Source 
Co-authored-by: parthp2107 <parth.panchal@deuexsoultions.com>
This commit is contained in:
parthp2107 2021-08-04 18:09:58 +05:30 committed by GitHub
parent 88ab3784a5
commit d53bae2e6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/editContent.sh
View File

@ -28,7 +28,7 @@ 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: `http://json-schema.org/draft-07/schema#`" >> $path
The schemas linked above follow the JSON Schema Spec version: http://json-schema.org/draft-07/schema#" >> $path
echo "----------------------Changing paths----------------------"
path=docs/openmetadata-apis/schemas/*/*.md

10
scripts/generateDirectories.sh
View File

@ -38,12 +38,12 @@ An Entity is a special type that has an identity and represents an object that i
| Abstract | Extensible |
| :--- | :--- |
| **id** | Mandatory attribute of type `UUID` 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 - `databaseService.database.table.` Attributes of an entity may also have `FQN` to uniquely identify a field. For example, a column of a table has `fqn` attribute set to `databaseService.database.table.columnName.` |
| **displayName** | Optional name used for display purposes. For example, the name could be`john.smith@domain.com` and `displayName` could be `John Smith.` |
| **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 `Database` entity needs `description` 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 `User, Team`, and `Organization`\). |
| **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**
@ -54,7 +54,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 `EntityReference` 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\).
@ -134,7 +134,7 @@ fi
sed -i d $path
echo "# Types
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`.
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