yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-23 16:38:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [main] 21 pages modified

Browse Source
This commit is contained in:
Parth Panchal 2021-08-16 05:20:54 +00:00 committed by gitbook-bot
parent 152d3aee2f
commit f6dd78f434
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
21 changed files with 89 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/openmetadata-apis/schemas/entities/bot.md
View File

@ -10,7 +10,7 @@ Type: `object`
* **id** * **id**
* Unique identifier of a bot instance. * Unique identifier of a bot instance.
* $ref: [../type/basic.json\#/definitions/uuid](bot.md#..typebasic.jsondefinitionsuuid) * $ref: [../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** * **name**
* Name of the bot. * Name of the bot.
* Type: `string` * Type: `string`
@ -23,5 +23,5 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this bot. * Link to the resource corresponding to this bot.
* $ref: [../type/basic.json\#/definitions/href](bot.md#..typebasic.jsondefinitionshref) * $ref: [../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)

10
docs/openmetadata-apis/schemas/entities/dashboard.md
View File

@ -10,7 +10,7 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies a dashboard instance. * Unique identifier that identifies a dashboard instance.
* $ref: [../../type/basic.json\#/definitions/uuid](dashboard.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies this dashboard. * Name that identifies this dashboard.
* Type: `string` * Type: `string`
@ -24,14 +24,14 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](dashboard.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **owner** * **owner**
* Owner of this dashboard. * Owner of this dashboard.
* $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **service** `required` * **service** `required`
* Link to service where this dashboard is hosted in. * Link to service where this dashboard is hosted in.
* $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **usageSummary** * **usageSummary**
* Latest usage information for this database. * Latest usage information for this database.
* $ref: [../../type/usageDetails.json](dashboard.md#....typeusagedetails.json) * $ref: [../../type/usageDetails.json](../types/usage-details.md)

10
docs/openmetadata-apis/schemas/entities/database-service.md
View File

@ -10,26 +10,26 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier of this database service instance. * Unique identifier of this database service instance.
* $ref: [../../type/basic.json\#/definitions/uuid](database-service.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies this database service. * Name that identifies this database service.
* Type: `string` * Type: `string`
* Length: between 1 and 64 * Length: between 1 and 64
* **serviceType** `required` * **serviceType** `required`
* Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... * Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
* $ref: [\#/definitions/databaseServiceType](database-service.md#/definitions/databaseServiceType) * $ref: [\#/definitions/databaseServiceType](database-service.md#types-definitions-in-this-schema)
* **description** * **description**
* Description of a database service instance. * Description of a database service instance.
* Type: `string` * Type: `string`
* **href** `required` * **href** `required`
* Link to the resource corresponding to this database service. * Link to the resource corresponding to this database service.
* $ref: [../../type/basic.json\#/definitions/href](database-service.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **jdbc** `required` * **jdbc** `required`
* JDBC connection information * JDBC connection information
* $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo](database-service.md#....typejdbcconnection.jsondefinitionsjdbcinfo) * $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo](../types/jdbc-connection.md#types-definitions-in-this-schema)
* **ingestionSchedule** * **ingestionSchedule**
* Schedule for running metadata ingestion jobs. * Schedule for running metadata ingestion jobs.
* $ref: [../../type/schedule.json](database-service.md#....typeschedule.json) * $ref: [../../type/schedule.json](../types/schedule.md)
## Types definitions in this schema ## Types definitions in this schema

14
docs/openmetadata-apis/schemas/entities/database.md
View File

@ -10,10 +10,10 @@ Type: `object`
* **id** * **id**
* Unique identifier that identifies this database instance. * Unique identifier that identifies this database instance.
* $ref: [../../type/basic.json\#/definitions/uuid](database.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies the database. * Name that identifies the database.
* $ref: [\#/definitions/databaseName](database.md#/definitions/databaseName) * $ref: [\#/definitions/databaseName](database.md#types-definitions-in-this-schema)
* **fullyQualifiedName** * **fullyQualifiedName**
* Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. * Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
* Type: `string` * Type: `string`
@ -22,19 +22,19 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](database.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **owner** * **owner**
* Owner of this database. * Owner of this database.
* $ref: [../../type/entityReference.json](database.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **service** `required` * **service** `required`
* Link to the database cluster/service where this database is hosted in. * Link to the database cluster/service where this database is hosted in.
* $ref: [../../type/entityReference.json](database.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **usageSummary** * **usageSummary**
* Latest usage information for this database. * Latest usage information for this database.
* $ref: [../../type/usageDetails.json](database.md#....typeusagedetails.json) * $ref: [../../type/usageDetails.json](../types/usage-details.md)
* **tables** * **tables**
* References to tables in the database. * References to tables in the database.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](database.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

10
docs/openmetadata-apis/schemas/entities/metrics.md
View File

@ -10,7 +10,7 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies this metrics instance. * Unique identifier that identifies this metrics instance.
* $ref: [../../type/basic.json\#/definitions/uuid](metrics.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies this metrics instance uniquely. * Name that identifies this metrics instance uniquely.
* Type: `string` * Type: `string`
@ -24,14 +24,14 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](metrics.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **owner** * **owner**
* Owner of this metrics. * Owner of this metrics.
* $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **service** `required` * **service** `required`
* Link to service where this metrics is hosted in. * Link to service where this metrics is hosted in.
* $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **usageSummary** * **usageSummary**
* Latest usage information for this database. * Latest usage information for this database.
* $ref: [../../type/usageDetails.json](metrics.md#....typeusagedetails.json) * $ref: [../../type/usageDetails.json](../types/usage-details.md)

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

@ -10,7 +10,7 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies a pipeline instance. * Unique identifier that identifies a pipeline instance.
* $ref: [../../type/basic.json\#/definitions/uuid](pipeline.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies this pipeline instance uniquely. * Name that identifies this pipeline instance uniquely.
* Type: `string` * Type: `string`
@ -24,11 +24,11 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](pipeline.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **owner** * **owner**
* Owner of this pipeline. * Owner of this pipeline.
* $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **service** `required` * **service** `required`
* Link to service where this pipeline is hosted in. * Link to service where this pipeline is hosted in.
* $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)

10
docs/openmetadata-apis/schemas/entities/report.md
View File

@ -10,7 +10,7 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies this report. * Unique identifier that identifies this report.
* $ref: [../../type/basic.json\#/definitions/uuid](report.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name that identifies the this report instance uniquely. * Name that identifies the this report instance uniquely.
* Type: `string` * Type: `string`
@ -24,14 +24,14 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the resource corresponding to this report. * Link to the resource corresponding to this report.
* $ref: [../../type/basic.json\#/definitions/href](report.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **owner** * **owner**
* Owner of this pipeline. * Owner of this pipeline.
* $ref: [../../type/entityReference.json](report.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **service** `required` * **service** `required`
* Link to service where this report is hosted in. * Link to service where this report is hosted in.
* $ref: [../../type/entityReference.json](report.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **usageSummary** * **usageSummary**
* Latest usage information for this database. * Latest usage information for this database.
* $ref: [../../type/usageDetails.json](report.md#....typeusagedetails.json) * $ref: [../../type/usageDetails.json](../types/usage-details.md)

24
docs/openmetadata-apis/schemas/entities/table.md
View File

@ -10,16 +10,16 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier of this table instance. * Unique identifier of this table instance.
* $ref: [../../type/basic.json\#/definitions/uuid](table.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* Name of a table. Expected to be unique within a database. * Name of a table. Expected to be unique within a database.
* $ref: [\#/definitions/tableName](table.md#/definitions/tableName) * $ref: [\#/definitions/tableName](table.md#types-definitions-in-this-schema)
* **description** * **description**
* Description of a table. * Description of a table.
* Type: `string` * Type: `string`
* **href** * **href**
* Link to this table resource. * Link to this table resource.
* $ref: [../../type/basic.json\#/definitions/href](table.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **tableType** * **tableType**
* $ref: [\#/definitions/tableType](table.md#/definitions/tableType) * $ref: [\#/definitions/tableType](table.md#/definitions/tableType)
* **fullyQualifiedName** * **fullyQualifiedName**
@ -29,35 +29,35 @@ Type: `object`
* Columns in this table. * Columns in this table.
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [\#/definitions/column](table.md#/definitions/column) * $ref: [\#/definitions/column](table.md#types-definitions-in-this-schema)
* **tableConstraints** * **tableConstraints**
* Table constraints. * Table constraints.
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [\#/definitions/tableConstraint](table.md#/definitions/tableConstraint) * $ref: [\#/definitions/tableConstraint](table.md#types-definitions-in-this-schema)
* **usageSummary** * **usageSummary**
* Latest usage information for this table. * Latest usage information for this table.
* $ref: [../../type/usageDetails.json](table.md#....typeusagedetails.json) * $ref: [../../type/usageDetails.json](../types/usage-details.md)
* **owner** * **owner**
* Owner of this table. * Owner of this table.
* $ref: [../../type/entityReference.json](table.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **followers** * **followers**
* Followers of this table. * Followers of this table.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](table.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
* **database** * **database**
* Reference to Database that contains this table. * Reference to Database that contains this table.
* $ref: [../../type/entityReference.json](table.md#....typeentityreference.json) * $ref: [../../type/entityReference.json](../types/entity-reference.md)
* **tags** * **tags**
* Tags for this table. * Tags for this table.
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json) * $ref: [../../type/tagLabel.json](../types/tag-label.md)
* **joins** * **joins**
* Details of other tables this table is frequently joined with. * Details of other tables this table is frequently joined with.
* $ref: [\#/definitions/tableJoins](table.md#/definitions/tableJoins) * $ref: [\#/definitions/tableJoins](table.md#types-definitions-in-this-schema)
* **sampleData** * **sampleData**
* Sample data for a table. * Sample data for a table.
* $ref: [\#/definitions/tableData](table.md#/definitions/tableData) * $ref: [\#/definitions/tableData](table.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

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

@ -11,15 +11,15 @@ This schema does not accept additional properties.
## Properties ## Properties
* **name** `required` * **name** `required`
* $ref: [\#/definitions/tagName](tag-category.md#/definitions/tagName) * $ref: [\#/definitions/tagName](tag-category.md#types-definitions-in-this-schema)
* **description** `required` * **description** `required`
* Description of the tag category. * Description of the tag category.
* Type: `string` * Type: `string`
* **categoryType** `required` * **categoryType** `required`
* $ref: [\#/definitions/tagCategoryType](tag-category.md#/definitions/tagCategoryType) * $ref: [\#/definitions/tagCategoryType](tag-category.md#types-definitions-in-this-schema)
* **href** * **href**
* Link to the resource corresponding to the tag category. * Link to the resource corresponding to the tag category.
* $ref: [../../type/basic.json\#/definitions/href](tag-category.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **usageCount** * **usageCount**
* Count of how many times the tags from this tag category are used. * Count of how many times the tags from this tag category are used.
* Type: `integer` * Type: `integer`
@ -27,7 +27,7 @@ This schema does not accept additional properties.
* Tags under this category. * Tags under this category.
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [\#/definitions/tag](tag-category.md#/definitions/tag) * $ref: [\#/definitions/tag](tag-category.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

10
docs/openmetadata-apis/schemas/entities/team.md
View File

@ -9,7 +9,7 @@ Type: `object`
## Properties ## Properties
* **id** `required` * **id** `required`
* $ref: [../../type/basic.json\#/definitions/uuid](team.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* $ref: [\#/definitions/teamName](team.md#/definitions/teamName) * $ref: [\#/definitions/teamName](team.md#/definitions/teamName)
* **displayName** * **displayName**
@ -20,19 +20,19 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** `required` * **href** `required`
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](team.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **profile** * **profile**
* Team profile information. * Team profile information.
* $ref: [../../type/profile.json](team.md#....typeprofile.json) * $ref: [../../type/profile.json](../types/profile.md)
* **deleted** * **deleted**
* When true the team has been deleted. * When true the team has been deleted.
* Type: `boolean` * Type: `boolean`
* **users** * **users**
* Users that are part of the team. * Users that are part of the team.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
* **owns** * **owns**
* List of entities owned by the team. * List of entities owned by the team.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

12
docs/openmetadata-apis/schemas/entities/thread.md
View File

@ -10,22 +10,22 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies an entity instance. * Unique identifier that identifies an entity instance.
* $ref: [../../type/basic.json\#/definitions/uuid](thread.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **href** * **href**
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](thread.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **threadTs** * **threadTs**
* Timestamp of the when the first post created the thread. * Timestamp of the when the first post created the thread.
* **about** `required` * **about** `required`
* Data asset about which this thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue}. * Data asset about which this thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
* $ref: [../../type/basic.json\#/definitions/entityLink](thread.md#....typebasic.jsondefinitionsentitylink) * $ref: [../../type/basic.json\#/definitions/entityLink](../types/basic.md#types-definitions-in-this-schema)
* **addressedTo** * **addressedTo**
* User or team this thread is addressed to in format <\#E/{enties}/{entityName}/{field}/{fieldValue}. * User or team this thread is addressed to in format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
* $ref: [../../type/basic.json\#/definitions/entityLink](thread.md#....typebasic.jsondefinitionsentitylink) * $ref: [../../type/basic.json\#/definitions/entityLink](../types/basic.md#types-definitions-in-this-schema)
* **posts** `required` * **posts** `required`
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [\#/definitions/post](thread.md#/definitions/post) * $ref: [\#/definitions/post](thread.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema
@ -43,5 +43,5 @@ Type: `object`
* String format must be a "date-time" * String format must be a "date-time"
* **from** `required` * **from** `required`
* ID of User \(regular user or a bot\) posting the message. * ID of User \(regular user or a bot\) posting the message.
* $ref: [../../type/basic.json\#/definitions/uuid](thread.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)

14
docs/openmetadata-apis/schemas/entities/user.md
View File

@ -12,7 +12,7 @@ This schema does not accept additional properties.
* **id** `required` * **id** `required`
* Unique identifier that identifies a user entity instance. * Unique identifier that identifies a user entity instance.
* $ref: [../../type/basic.json\#/definitions/uuid](user.md#....typebasic.jsondefinitionsuuid) * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
* **name** `required` * **name** `required`
* $ref: [\#/definitions/userName](user.md#/definitions/userName) * $ref: [\#/definitions/userName](user.md#/definitions/userName)
* **displayName** * **displayName**
@ -20,10 +20,10 @@ This schema does not accept additional properties.
* Type: `string` * Type: `string`
* **email** `required` * **email** `required`
* Email address of the user. * Email address of the user.
* $ref: [../../type/basic.json\#/definitions/email](user.md#....typebasic.jsondefinitionsemail) * $ref: [../../type/basic.json\#/definitions/email](../types/basic.md#types-definitions-in-this-schema)
* **href** `required` * **href** `required`
* Link to the resource corresponding to this entity. * Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](user.md#....typebasic.jsondefinitionshref) * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
* **timezone** * **timezone**
* Timezone of the user. * Timezone of the user.
* Type: `string` * Type: `string`
@ -39,16 +39,16 @@ This schema does not accept additional properties.
* Type: `boolean` * Type: `boolean`
* **profile** * **profile**
* Profile of the user. * Profile of the user.
* $ref: [../../type/profile.json](user.md#....typeprofile.json) * $ref: [../../type/profile.json](../types/profile.md)
* **teams** * **teams**
* Teams that the user belongs to. * Teams that the user belongs to.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
* **owns** * **owns**
* List of entities owned by the user. * List of entities owned by the user.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
* **follows** * **follows**
* List of entities followed by the user. * List of entities followed by the user.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

4
docs/openmetadata-apis/schemas/types/audit-log.md
View File

@ -27,10 +27,10 @@ Type: `object`
* Type: `string` * Type: `string`
* **dateTime** * **dateTime**
* Date which the api call is made. * Date which the api call is made.
* $ref: [basic.json\#/definitions/dateTime](audit-log.md#basic.jsondefinitionsdatetime) * $ref: [basic.json\#/definitions/dateTime](basic.md#types-definitions-in-this-schema)
* **entityId** `required` * **entityId** `required`
* Entity Id that was modified by the operation. * Entity Id that was modified by the operation.
* $ref: [basic.json\#/definitions/uuid](audit-log.md#basic.jsondefinitionsuuid) * $ref: [basic.json\#/definitions/uuid](basic.md#types-definitions-in-this-schema)
* **entityType** `required` * **entityType** `required`
* Entity Type that modified by the operation. * Entity Type that modified by the operation.
* Type: `string` * Type: `string`

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

@ -15,5 +15,5 @@ This schema does not accept additional properties.
* Type: `integer` * Type: `integer`
* Range: ≥ 0 * Range: ≥ 0
* **date** `required` * **date** `required`
* $ref: [basic.json\#/definitions/date](daily-count.md#basic.jsondefinitionsdate) * $ref: [basic.json\#/definitions/date](basic.md#types-definitions-in-this-schema)

6
docs/openmetadata-apis/schemas/types/entity-reference.md
View File

@ -10,7 +10,7 @@ Type: `object`
* **id** `required` * **id** `required`
* Unique identifier that identifies an entity instance. * Unique identifier that identifies an entity instance.
* $ref: [basic.json\#/definitions/uuid](entity-reference.md#basic.jsondefinitionsuuid) * $ref: [basic.json\#/definitions/uuid](basic.md#types-definitions-in-this-schema)
* **type** `required` * **type** `required`
* Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... * Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
* Type: `string` * Type: `string`
@ -22,7 +22,7 @@ Type: `object`
* Type: `string` * Type: `string`
* **href** * **href**
* Link to the entity resource. * Link to the entity resource.
* $ref: [basic.json\#/definitions/href](entity-reference.md#basic.jsondefinitionshref) * $ref: [basic.json\#/definitions/href](basic.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema
@ -30,5 +30,5 @@ Type: `object`
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [entityReference.json](entity-reference.md#entityreference.json) * $ref: [entityReference.json](entity-reference.md)

4
docs/openmetadata-apis/schemas/types/entity-usage.md
View File

@ -10,10 +10,10 @@ Type: `object`
* **entity** `required` * **entity** `required`
* Entity for which usage is returned. * Entity for which usage is returned.
* $ref: [entityReference.json](entity-usage.md#entityreference.json) * $ref: [entityReference.json](entity-reference.md)
* **usage** `required` * **usage** `required`
* List usage details per day. * List usage details per day.
* Type: `array` * Type: `array`
* **Items** * **Items**
* $ref: [usageDetails.json](entity-usage.md#usagedetails.json) * $ref: [usageDetails.json](usage-details.md)

8
docs/openmetadata-apis/schemas/types/jdbc-connection.md
View File

@ -10,10 +10,10 @@ Type: `object`
* **driverClass** `required` * **driverClass** `required`
* JDBC driver class * JDBC driver class
* $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass) * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema)
* **connectionUrl** `required` * **connectionUrl** `required`
* JDBC connection URL * JDBC connection URL
* $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema)
* **userName** `required` * **userName** `required`
* Login user name. * Login user name.
* Type: `string` * Type: `string`
@ -40,8 +40,8 @@ Type: `object`
* Type: `object` * Type: `object`
* **Properties** * **Properties**
* **driverClass** `required` * **driverClass** `required`
* $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass) * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema)
* Default: _"com.amazon.redshift.jdbc42.Driver"_ * Default: _"com.amazon.redshift.jdbc42.Driver"_
* **connectionUrl** `required` * **connectionUrl** `required`
* $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema)

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

@ -9,7 +9,7 @@ Type: `object`
## Properties ## Properties
* **images** * **images**
* $ref: [\#/definitions/imageList](profile.md#/definitions/imageList) * $ref: [\#/definitions/imageList](profile.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema

6
docs/openmetadata-apis/schemas/types/schedule.md
View File

@ -10,8 +10,10 @@ Type: `object`
* **startDate** * **startDate**
* Start date and time of the schedule. * Start date and time of the schedule.
* $ref: [basic.json\#/definitions/dateTime](schedule.md#basic.jsondefinitionsdatetime) * $ref: [basic.json\#/definitions/dateTime](basic.md#types-definitions-in-this-schema)
* **repeatFrequency** * **repeatFrequency**
* Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H' * Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'
* $ref: [basic.json\#/definitions/duration](schedule.md#basic.jsondefinitionsduration) * $ref: [basic.json\#/definitions/duration](basic.md#types-definitions-in-this-schema)

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

@ -29,5 +29,5 @@ Type: `object`
* Default: _"Confirmed"_ * Default: _"Confirmed"_
* **href** * **href**
* Link to the tag resource. * Link to the tag resource.
* $ref: [basic.json\#/definitions/href](tag-label.md#basic.jsondefinitionshref) * $ref: [basic.json\#/definitions/href](basic.md#types-definitions-in-this-schema)

8
docs/openmetadata-apis/schemas/types/usage-details.md
View File

@ -10,16 +10,16 @@ Type: `object`
* **dailyStats** `required` * **dailyStats** `required`
* Daily usage stats of a data asset on the start date. * Daily usage stats of a data asset on the start date.
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
* **weeklyStats** * **weeklyStats**
* Weekly \(last 7 days\) rolling usage stats of a data asset on the start date. * Weekly \(last 7 days\) rolling usage stats of a data asset on the start date.
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
* **monthlyStats** * **monthlyStats**
* Monthly \(last 30 days\) rolling usage stats of a data asset on the start date. * Monthly \(last 30 days\) rolling usage stats of a data asset on the start date.
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
* **date** `required` * **date** `required`
* Date in UTC. * Date in UTC.
* $ref: [basic.json\#/definitions/date](usage-details.md#basic.jsondefinitionsdate) * $ref: [basic.json\#/definitions/date](basic.md#types-definitions-in-this-schema)
## Types definitions in this schema ## Types definitions in this schema