From f6dd78f434049bfea2c0b0902817e69e6f8f789c Mon Sep 17 00:00:00 2001 From: Parth Panchal Date: Mon, 16 Aug 2021 05:20:54 +0000 Subject: [PATCH] GitBook: [main] 21 pages modified --- .../openmetadata-apis/schemas/entities/bot.md | 4 ++-- .../schemas/entities/dashboard.md | 10 ++++---- .../schemas/entities/database-service.md | 10 ++++---- .../schemas/entities/database.md | 14 +++++------ .../schemas/entities/metrics.md | 10 ++++---- .../schemas/entities/pipeline.md | 8 +++---- .../schemas/entities/report.md | 10 ++++---- .../schemas/entities/table.md | 24 +++++++++---------- .../schemas/entities/tag-category.md | 8 +++---- .../schemas/entities/team.md | 10 ++++---- .../schemas/entities/thread.md | 12 +++++----- .../schemas/entities/user.md | 14 +++++------ .../schemas/types/audit-log.md | 4 ++-- .../schemas/types/daily-count.md | 2 +- .../schemas/types/entity-reference.md | 6 ++--- .../schemas/types/entity-usage.md | 4 ++-- .../schemas/types/jdbc-connection.md | 8 +++---- .../schemas/types/profile.md | 2 +- .../schemas/types/schedule.md | 6 +++-- .../schemas/types/tag-label.md | 2 +- .../schemas/types/usage-details.md | 8 +++---- 21 files changed, 89 insertions(+), 87 deletions(-) diff --git a/docs/openmetadata-apis/schemas/entities/bot.md b/docs/openmetadata-apis/schemas/entities/bot.md index 8f41b658d23..0bc7a8f7ced 100644 --- a/docs/openmetadata-apis/schemas/entities/bot.md +++ b/docs/openmetadata-apis/schemas/entities/bot.md @@ -10,7 +10,7 @@ Type: `object` * **id** * 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 of the bot. * Type: `string` @@ -23,5 +23,5 @@ Type: `object` * Type: `string` * **href** * 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) diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md index a9949889d54..245b7edf484 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/dashboard.md @@ -10,7 +10,7 @@ Type: `object` * **id** `required` * 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 that identifies this dashboard. * Type: `string` @@ -24,14 +24,14 @@ Type: `object` * Type: `string` * **href** * 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 of this dashboard. - * $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **service** `required` * 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** * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](dashboard.md#....typeusagedetails.json) + * $ref: [../../type/usageDetails.json](../types/usage-details.md) diff --git a/docs/openmetadata-apis/schemas/entities/database-service.md b/docs/openmetadata-apis/schemas/entities/database-service.md index cd488494bb4..32ec28b683b 100644 --- a/docs/openmetadata-apis/schemas/entities/database-service.md +++ b/docs/openmetadata-apis/schemas/entities/database-service.md @@ -10,26 +10,26 @@ Type: `object` * **id** `required` * 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 that identifies this database service. * Type: `string` * Length: between 1 and 64 * **serviceType** `required` * 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 of a database service instance. * Type: `string` * **href** `required` * 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 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** * 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 diff --git a/docs/openmetadata-apis/schemas/entities/database.md b/docs/openmetadata-apis/schemas/entities/database.md index c2049d02d5f..2ca4077e978 100644 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ b/docs/openmetadata-apis/schemas/entities/database.md @@ -10,10 +10,10 @@ Type: `object` * **id** * 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 that identifies the database. - * $ref: [\#/definitions/databaseName](database.md#/definitions/databaseName) + * $ref: [\#/definitions/databaseName](database.md#types-definitions-in-this-schema) * **fullyQualifiedName** * Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. * Type: `string` @@ -22,19 +22,19 @@ Type: `object` * Type: `string` * **href** * 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 of this database. - * $ref: [../../type/entityReference.json](database.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **service** `required` * 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** * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](database.md#....typeusagedetails.json) + * $ref: [../../type/usageDetails.json](../types/usage-details.md) * **tables** * 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 diff --git a/docs/openmetadata-apis/schemas/entities/metrics.md b/docs/openmetadata-apis/schemas/entities/metrics.md index d00875ae41b..c519bd9bca5 100644 --- a/docs/openmetadata-apis/schemas/entities/metrics.md +++ b/docs/openmetadata-apis/schemas/entities/metrics.md @@ -10,7 +10,7 @@ Type: `object` * **id** `required` * 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 that identifies this metrics instance uniquely. * Type: `string` @@ -24,14 +24,14 @@ Type: `object` * Type: `string` * **href** * 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 of this metrics. - * $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **service** `required` * 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** * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](metrics.md#....typeusagedetails.json) + * $ref: [../../type/usageDetails.json](../types/usage-details.md) diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md index 415318dd231..d135ef93232 100644 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/pipeline.md @@ -10,7 +10,7 @@ Type: `object` * **id** `required` * 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 that identifies this pipeline instance uniquely. * Type: `string` @@ -24,11 +24,11 @@ Type: `object` * Type: `string` * **href** * 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 of this pipeline. - * $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **service** `required` * 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) diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md index 04f1e69a2e4..15bff79fd06 100644 --- a/docs/openmetadata-apis/schemas/entities/report.md +++ b/docs/openmetadata-apis/schemas/entities/report.md @@ -10,7 +10,7 @@ Type: `object` * **id** `required` * 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 that identifies the this report instance uniquely. * Type: `string` @@ -24,14 +24,14 @@ Type: `object` * Type: `string` * **href** * 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 of this pipeline. - * $ref: [../../type/entityReference.json](report.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **service** `required` * 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** * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](report.md#....typeusagedetails.json) + * $ref: [../../type/usageDetails.json](../types/usage-details.md) diff --git a/docs/openmetadata-apis/schemas/entities/table.md b/docs/openmetadata-apis/schemas/entities/table.md index ff83d86a216..e2b70964f50 100644 --- a/docs/openmetadata-apis/schemas/entities/table.md +++ b/docs/openmetadata-apis/schemas/entities/table.md @@ -10,16 +10,16 @@ Type: `object` * **id** `required` * 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 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 of a table. * Type: `string` * **href** * 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** * $ref: [\#/definitions/tableType](table.md#/definitions/tableType) * **fullyQualifiedName** @@ -29,35 +29,35 @@ Type: `object` * Columns in this table. * Type: `array` * **Items** - * $ref: [\#/definitions/column](table.md#/definitions/column) + * $ref: [\#/definitions/column](table.md#types-definitions-in-this-schema) * **tableConstraints** * Table constraints. * Type: `array` * **Items** - * $ref: [\#/definitions/tableConstraint](table.md#/definitions/tableConstraint) + * $ref: [\#/definitions/tableConstraint](table.md#types-definitions-in-this-schema) * **usageSummary** * Latest usage information for this table. - * $ref: [../../type/usageDetails.json](table.md#....typeusagedetails.json) + * $ref: [../../type/usageDetails.json](../types/usage-details.md) * **owner** * Owner of this table. - * $ref: [../../type/entityReference.json](table.md#....typeentityreference.json) + * $ref: [../../type/entityReference.json](../types/entity-reference.md) * **followers** * 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** * 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 for this table. * Type: `array` * **Items** - * $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json) + * $ref: [../../type/tagLabel.json](../types/tag-label.md) * **joins** * 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** * 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 diff --git a/docs/openmetadata-apis/schemas/entities/tag-category.md b/docs/openmetadata-apis/schemas/entities/tag-category.md index ec36232aa2c..c4dcd3d47f6 100644 --- a/docs/openmetadata-apis/schemas/entities/tag-category.md +++ b/docs/openmetadata-apis/schemas/entities/tag-category.md @@ -11,15 +11,15 @@ This schema does not accept additional properties. ## Properties * **name** `required` - * $ref: [\#/definitions/tagName](tag-category.md#/definitions/tagName) + * $ref: [\#/definitions/tagName](tag-category.md#types-definitions-in-this-schema) * **description** `required` * Description of the tag category. * Type: `string` * **categoryType** `required` - * $ref: [\#/definitions/tagCategoryType](tag-category.md#/definitions/tagCategoryType) + * $ref: [\#/definitions/tagCategoryType](tag-category.md#types-definitions-in-this-schema) * **href** * 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** * Count of how many times the tags from this tag category are used. * Type: `integer` @@ -27,7 +27,7 @@ This schema does not accept additional properties. * Tags under this category. * Type: `array` * **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 diff --git a/docs/openmetadata-apis/schemas/entities/team.md b/docs/openmetadata-apis/schemas/entities/team.md index 5a94c638747..5b97740db4c 100644 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ b/docs/openmetadata-apis/schemas/entities/team.md @@ -9,7 +9,7 @@ Type: `object` ## Properties * **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` * $ref: [\#/definitions/teamName](team.md#/definitions/teamName) * **displayName** @@ -20,19 +20,19 @@ Type: `object` * Type: `string` * **href** `required` * 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** * Team profile information. - * $ref: [../../type/profile.json](team.md#....typeprofile.json) + * $ref: [../../type/profile.json](../types/profile.md) * **deleted** * When true the team has been deleted. * Type: `boolean` * **users** * 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** * 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 diff --git a/docs/openmetadata-apis/schemas/entities/thread.md b/docs/openmetadata-apis/schemas/entities/thread.md index 898dd4dc5e6..8a34fde5cbe 100644 --- a/docs/openmetadata-apis/schemas/entities/thread.md +++ b/docs/openmetadata-apis/schemas/entities/thread.md @@ -10,22 +10,22 @@ Type: `object` * **id** `required` * 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** * 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** * Timestamp of the when the first post created the thread. * **about** `required` * 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** * 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` * Type: `array` * **Items** - * $ref: [\#/definitions/post](thread.md#/definitions/post) + * $ref: [\#/definitions/post](thread.md#types-definitions-in-this-schema) ## Types definitions in this schema @@ -43,5 +43,5 @@ Type: `object` * String format must be a "date-time" * **from** `required` * 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) diff --git a/docs/openmetadata-apis/schemas/entities/user.md b/docs/openmetadata-apis/schemas/entities/user.md index 57cf78c17a2..7abcdd6f482 100644 --- a/docs/openmetadata-apis/schemas/entities/user.md +++ b/docs/openmetadata-apis/schemas/entities/user.md @@ -12,7 +12,7 @@ This schema does not accept additional properties. * **id** `required` * 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` * $ref: [\#/definitions/userName](user.md#/definitions/userName) * **displayName** @@ -20,10 +20,10 @@ This schema does not accept additional properties. * Type: `string` * **email** `required` * 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` * 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 of the user. * Type: `string` @@ -39,16 +39,16 @@ This schema does not accept additional properties. * Type: `boolean` * **profile** * Profile of the user. - * $ref: [../../type/profile.json](user.md#....typeprofile.json) + * $ref: [../../type/profile.json](../types/profile.md) * **teams** * 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** * 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** * 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 diff --git a/docs/openmetadata-apis/schemas/types/audit-log.md b/docs/openmetadata-apis/schemas/types/audit-log.md index 6ffc119e6cd..47a6f0e32fc 100644 --- a/docs/openmetadata-apis/schemas/types/audit-log.md +++ b/docs/openmetadata-apis/schemas/types/audit-log.md @@ -27,10 +27,10 @@ Type: `object` * Type: `string` * **dateTime** * 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` * 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` * Entity Type that modified by the operation. * Type: `string` diff --git a/docs/openmetadata-apis/schemas/types/daily-count.md b/docs/openmetadata-apis/schemas/types/daily-count.md index 808ea6ca6c7..0a6c66e63fb 100644 --- a/docs/openmetadata-apis/schemas/types/daily-count.md +++ b/docs/openmetadata-apis/schemas/types/daily-count.md @@ -15,5 +15,5 @@ This schema does not accept additional properties. * Type: `integer` * Range: ≥ 0 * **date** `required` - * $ref: [basic.json\#/definitions/date](daily-count.md#basic.jsondefinitionsdate) + * $ref: [basic.json\#/definitions/date](basic.md#types-definitions-in-this-schema) diff --git a/docs/openmetadata-apis/schemas/types/entity-reference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md index cd3d6d6bb4f..a4b54547b90 100644 --- a/docs/openmetadata-apis/schemas/types/entity-reference.md +++ b/docs/openmetadata-apis/schemas/types/entity-reference.md @@ -10,7 +10,7 @@ Type: `object` * **id** `required` * 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` * Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... * Type: `string` @@ -22,7 +22,7 @@ Type: `object` * Type: `string` * **href** * 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 @@ -30,5 +30,5 @@ Type: `object` * Type: `array` * **Items** - * $ref: [entityReference.json](entity-reference.md#entityreference.json) + * $ref: [entityReference.json](entity-reference.md) diff --git a/docs/openmetadata-apis/schemas/types/entity-usage.md b/docs/openmetadata-apis/schemas/types/entity-usage.md index 8e3a000778b..07c3c77cb10 100644 --- a/docs/openmetadata-apis/schemas/types/entity-usage.md +++ b/docs/openmetadata-apis/schemas/types/entity-usage.md @@ -10,10 +10,10 @@ Type: `object` * **entity** `required` * Entity for which usage is returned. - * $ref: [entityReference.json](entity-usage.md#entityreference.json) + * $ref: [entityReference.json](entity-reference.md) * **usage** `required` * List usage details per day. * Type: `array` * **Items** - * $ref: [usageDetails.json](entity-usage.md#usagedetails.json) + * $ref: [usageDetails.json](usage-details.md) diff --git a/docs/openmetadata-apis/schemas/types/jdbc-connection.md b/docs/openmetadata-apis/schemas/types/jdbc-connection.md index e9da92e2ef4..7dd35812596 100644 --- a/docs/openmetadata-apis/schemas/types/jdbc-connection.md +++ b/docs/openmetadata-apis/schemas/types/jdbc-connection.md @@ -10,10 +10,10 @@ Type: `object` * **driverClass** `required` * JDBC driver class - * $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass) + * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema) * **connectionUrl** `required` * JDBC connection URL - * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) + * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema) * **userName** `required` * Login user name. * Type: `string` @@ -40,8 +40,8 @@ Type: `object` * Type: `object` * **Properties** * **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"_ * **connectionUrl** `required` - * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) + * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema) diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index e5c81eaa91e..73949e7ea7d 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -9,7 +9,7 @@ Type: `object` ## Properties * **images** - * $ref: [\#/definitions/imageList](profile.md#/definitions/imageList) + * $ref: [\#/definitions/imageList](profile.md#types-definitions-in-this-schema) ## Types definitions in this schema diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index c3b3eed591f..33757a72892 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -10,8 +10,10 @@ Type: `object` * **startDate** * 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** * 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) + + diff --git a/docs/openmetadata-apis/schemas/types/tag-label.md b/docs/openmetadata-apis/schemas/types/tag-label.md index e3eac7b35ea..1eb7dd33b83 100644 --- a/docs/openmetadata-apis/schemas/types/tag-label.md +++ b/docs/openmetadata-apis/schemas/types/tag-label.md @@ -29,5 +29,5 @@ Type: `object` * Default: _"Confirmed"_ * **href** * 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) diff --git a/docs/openmetadata-apis/schemas/types/usage-details.md b/docs/openmetadata-apis/schemas/types/usage-details.md index e66c30e2654..63f493846c8 100644 --- a/docs/openmetadata-apis/schemas/types/usage-details.md +++ b/docs/openmetadata-apis/schemas/types/usage-details.md @@ -10,16 +10,16 @@ Type: `object` * **dailyStats** `required` * 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** * 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** * 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 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