diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 2985d1272f5..2beb904c41d 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -7,29 +7,28 @@ * [Schemas](openmetadata-apis/schemas/README.md) * [Types](openmetadata-apis/schemas/types/README.md) - * [Basic Type](openmetadata-apis/schemas/types/basic.md) - * [Collection Descriptor Type](openmetadata-apis/schemas/types/collectiondescriptor.md) - * [Daily Count Type](openmetadata-apis/schemas/types/dailycount.md) - * [Entity Reference Type](openmetadata-apis/schemas/types/entityreference.md) - * [Entity Usage Type](openmetadata-apis/schemas/types/entity-usage-type.md) - * [Jdbc Connection Type](openmetadata-apis/schemas/types/jdbcconnection.md) - * [Profile Type](openmetadata-apis/schemas/types/profile.md) - * [Schedule Type](openmetadata-apis/schemas/types/schedule.md) - * [Tag Label Type](openmetadata-apis/schemas/types/taglabel.md) - * [Usage Details Type](openmetadata-apis/schemas/types/usagedetails.md) + * [Basic](openmetadata-apis/schemas/types/basic.md) + * [Daily Count](openmetadata-apis/schemas/types/dailyDount.md) + * [Entity Reference](openmetadata-apis/schemas/types/entityReference.md) + * [Entity Usage](openmetadata-apis/schemas/types/entityUsage.md) + * [Jdbc Connection](openmetadata-apis/schemas/types/jdbcconnection.md) + * [Profile](openmetadata-apis/schemas/types/profile.md) + * [Schedule](openmetadata-apis/schemas/types/schedule.md) + * [Tag Label](openmetadata-apis/schemas/types/taglabel.md) + * [Usage Details](openmetadata-apis/schemas/types/usagedetails.md) * [Entities](openmetadata-apis/schemas/entities/README.md) - * [Bot Entity](openmetadata-apis/schemas/entities/bots.md) - * [Dashboard Entity](openmetadata-apis/schemas/entities/dashboard.md) - * [Database Entity](openmetadata-apis/schemas/entities/database.md) - * [Database Service Entity](openmetadata-apis/schemas/entities/databaseservice.md) - * [Feed Entity](openmetadata-apis/schemas/entities/thread.md) - * [Metrics Entity](openmetadata-apis/schemas/entities/metrics.md) - * [Pipeline Entity](openmetadata-apis/schemas/entities/pipeline.md) - * [Report Entity](openmetadata-apis/schemas/entities/report.md) - * [Table Entity](openmetadata-apis/schemas/entities/table.md) - * [Team Entity](openmetadata-apis/schemas/entities/team.md) - * [Tag Categoty Entity](openmetadata-apis/schemas/entities/tagcategory.md) - * [User entity](openmetadata-apis/schemas/entities/user.md) + * [Bot](openmetadata-apis/schemas/entities/bots.md) + * [Dashboard](openmetadata-apis/schemas/entities/data/dashboard.md) + * [Database](openmetadata-apis/schemas/entities/data/database.md) + * [Database Service](openmetadata-apis/schemas/entities/services/databaseservice.md) + * [Feed](openmetadata-apis/schemas/entities/feed/thread.md) + * [Metrics](openmetadata-apis/schemas/entities/data/metrics.md) + * [Pipeline](openmetadata-apis/schemas/entities/data/pipeline.md) + * [Report](openmetadata-apis/schemas/entities/data/report.md) + * [Table](openmetadata-apis/schemas/entities/data/table.md) + * [Team](openmetadata-apis/schemas/entities/team/team.md) + * [Tag Categoty](openmetadata-apis/schemas/entities/tags/tagcategory.md) + * [User](openmetadata-apis/schemas/entities/team/user.md) * [APIs](openmetadata-apis/apis/README.md) * [Overview](openmetadata-apis/apis/overview.md) diff --git a/docs/openmetadata-apis/schemas/types/README.md b/docs/openmetadata-apis/schemas/types/README.md index ad2ce5069a8..700114c4fea 100644 --- a/docs/openmetadata-apis/schemas/types/README.md +++ b/docs/openmetadata-apis/schemas/types/README.md @@ -5,20 +5,20 @@ JSON schema supports many native types - `null`, `boolean`, `object`, `array`, ` ## List of Schema Types {% page-ref page="basic.md" %} -{% page-ref page="collectiondescriptor.md" %} +{% page-ref page="collectionDescriptor.md" %} -{% page-ref page="dailycount.md" %} +{% page-ref page="dailyDount.md" %} -{% page-ref page="entityreference.md" %} +{% page-ref page="entityReference.md" %} -{% page-ref page="entityusage.md" %} +{% page-ref page="entityUsage.md" %} -{% page-ref page="jdbcconnection.md" %} +{% page-ref page="jdbcConnection.md" %} {% page-ref page="profile.md" %} {% page-ref page="schedule.md" %} -{% page-ref page="taglabel.md" %} +{% page-ref page="tagLabel.md" %} -{% page-ref page="usagedetails.md" %} \ No newline at end of file +{% page-ref page="usageDetails.md" %} diff --git a/docs/openmetadata-apis/schemas/types/auditLog.md b/docs/openmetadata-apis/schemas/types/auditLog.md new file mode 100644 index 00000000000..fc445d7168f --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/auditLog.md @@ -0,0 +1,37 @@ +# Audit Log + +This schema defines type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json + +Type: `object` + +## Properties + - method `required` + - HTTP Method used in a call. + - Type: `string` + - The value is restricted to the following: + 1. _"POST"_ + 2. _"PUT"_ + 3. _"PATCH"_ + 4. _"DELETE"_ + - responseCode `required` + - HTTP response code for the api requested. + - Type: `integer` + - path `required` + - Requested API Path. + - Type: `string` + - userName `required` + - Name of the user who requested for the API. + - Type: `string` + - dateTime + - Date which the api call is made. + - $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime) + - entityId `required` + - Entity Id that was modified by the operation. + - $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid) + - entityType `required` + - Entity Type that modified by the operation. + - Type: `string` + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index 145d966f0f0..de9bf49cd5f 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -1,470 +1,80 @@ -# Basic Type +# Basic -## basic +This schema defines basic common types that are used by other schemas. -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json -``` +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json -Common reusable types -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Cannot be instantiated | Yes | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [basic.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | -### Common types Type +## Definitions +**_uuid_** -unknown \([Common types](basic.md)\) + - Unique id used to identify an entity. + - Type: `string` + - String format must be a "uuid" -## Common types Definitions -### Definitions group uuid +**_email_** -Reference this group by using + - Email address of a user or other entities. + - Type: `string` + - String format must be a "email" + - The value must match this pattern: `^\S+@\S+\.\S+$` + - Length: between 6 and 127 -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/uuid"} -``` -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | +**_entityLink_** + - Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`. + - Type: `string` + - The value must match this pattern: `^<#E/\S+/\S+>$` -### Definitions group schema -Reference this group by using +**_timestamp_** -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/schema"} -``` + - Time stamp in unixTimeMillis + - Type: `string` + - String format must be a "utc-millisec" -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | +**_href_** -### Definitions group email + - href that points to a resource. + - Type: `string` + - String format must be a "uri" -Reference this group by using -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/email"} -``` +**_timeInterval_** -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | + - Type: `object` + - **_Properties_** + - start + - Start time in unixTimeMillis. + - Type: `integer` + - end + - End time in unixTimeMillis. + - Type: `integer` -### Definitions group entityLink +**_duration_** -Reference this group by using + - Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'. + - Type: `string` -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/entityLink"} -``` -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | +**_date_** + - Date in ISO 8601 format in UTC time. Example - '2018-11-13'. + - Type: `string` + - String format must be a "date" -### Definitions group timestamp -Reference this group by using +**_dateTime_** -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/timestamp"} -``` + - Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'. + - Type: `string` + - String format must be a "date-Time" -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -### Definitions group href - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/href"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -### Definitions group timeInterval - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/timeInterval"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [start](basic.md#start) | `integer` | Optional | cannot be null | [Basic type](basic.md#basic-definitions-timeinterval-properties-start) | -| [end](basic.md#end) | `integer` | Optional | cannot be null | \#[Basic type](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-timeinterval-properties-end/README.md) | - -#### start - -Start unixTimeMillis - -`start` - -* is optional -* Type: `integer` -* cannot be null -* defined in: [Basic type](basic.md#basic-definitions-timeinterval-properties-start) - -**start Type** - -`integer` - -#### end - -End unixTimeMillis - -`end` - -* is optional -* Type: `integer` -* cannot be null -* defined in: \#[Basic type](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-timeinterval-properties-end/README.md) - -**end Type** - -`integer` - -### Definitions group duration - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/duration"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -### Definitions group date - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/date"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -### Definitions group dateTime - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/dateTime"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -## basic-definitions-date - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/definitions/tableJoins/properties/startDate -``` - -Date in ISO 8601 format in UTC time. Example - '2018-11-13' - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [table.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json) | - -### startDate Type - -`string` - -### startDate Constraints - -**date**: the string must be a date string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339) - -## basic-definitions-datetime - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json#/properties/startDate -``` - -Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00' - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [schedule.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json) | - -### startDate Type - -`string` - -### startDate Constraints - -**unknown format**: the value of this string must follow the format: `date-Time` - -## basic-definitions-duration - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json#/properties/repeatFrequency -``` - -Duration in ISO 8601 format in UTC time. Example - 'P23DT23H' - -> Jsonschema does not handle ISO 8601 duration yet and hence no format for this type - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [schedule.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json) | - -### repeatFrequency Type - -`string` - -## basic-definitions-email - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json#/properties/email -``` - -Email address of user or other entities - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [createUser.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json) | - -### email Type - -`string` - -### email Constraints - -**maximum length**: the maximum number of characters for this string is: `127` - -**minimum length**: the minimum number of characters for this string is: `6` - -**pattern**: the string must match the following regular expression: - -```text -^\S+@\S+\.\S+$ -``` - -[try pattern](https://regexr.com/?expression=%5E%5CS%2B%40%5CS%2B%5C.%5CS%2B%24) - -**email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322) - -## basic-definitions-entitylink - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/feed/createThread.json#/properties/about -``` - -Entity or field thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue} - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [createThread.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/api/feed/createThread.json) | - -### about Type - -`string` - -### about Constraints - -**pattern**: the string must match the following regular expression: - -```text -^<#E/\S+/\S+>$ -``` - -[try pattern](https://regexr.com/?expression=%5E%3C%23E%2F%5CS%2B%2F%5CS%2B%3E%24) - -## basic-definitions-href - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/href -``` - -Link to this table resource - -> Link to the resource - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [table.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json) | - -### href Type - -`string` - -### href Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## basic-definitions-schema - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/schema -``` - -URL for the schema of an entity - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [basic.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | - -### schema Type - -`string` - -### schema Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## basic-definitions-timeinterval-properties-end - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/timeInterval/properties/end -``` - -End unixTimeMillis - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [basic.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | - -### end Type - -`integer` - -## basic-definitions-timeinterval-properties-start - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/timeInterval/properties/start -``` - -Start unixTimeMillis - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [basic.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | - -### start Type - -`integer` - -## basic-definitions-timeinterval - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions/timeInterval -``` - -> Time interval type - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [basic.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | - -### timeInterval Type - -`object` \([Details](basic.md#basic-definitions-timeinterval)\) - -## timeInterval Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [start](basic.md#start) | `integer` | Optional | cannot be null | [Basic type](basic.md#basic-definitions-timeinterval-properties-start) | -| [end](basic.md#end) | `integer` | Optional | cannot be null | \#[Basic type](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-timeinterval-properties-end/README.md) | - -### start - -Start unixTimeMillis - -`start` - -* is optional -* Type: `integer` -* cannot be null -* defined in: [Basic type](basic.md#basic-definitions-timeinterval-properties-start) - -#### start Type - -`integer` - -### end - -End unixTimeMillis - -`end` - -* is optional -* Type: `integer` -* cannot be null -* defined in: \#[Basic type](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-timeinterval-properties-end/README.md) - -#### end Type - -`integer` - -## basic-definitions-timestamp - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/catalogVersion.json#/properties/timestamp -``` - -Build timestamp - -> Timestamp type - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [catalogVersion.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/catalogVersion.json) | - -### timestamp Type - -`string` - -### timestamp Constraints - -**unknown format**: the value of this string must follow the format: `utc-millisec` - -## basic-definitions-uuid - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/database -``` - -Unique id used to identify an entity - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [createTable.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json) | - -### database Type - -`string` - -### database Constraints - -**UUID**: the string must be a UUID, according to [RFC 4122](https://tools.ietf.org/html/rfc4122) - -## basic-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [basic.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) | - -### definitions Type - -unknown - +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/collectionDescriptor.md b/docs/openmetadata-apis/schemas/types/collectionDescriptor.md new file mode 100644 index 00000000000..8a17db2c11d --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/collectionDescriptor.md @@ -0,0 +1,35 @@ +# Schema for collection descriptor + +Type used for capturing the details of a collection. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json + +Type: `object` + +## Properties + - collection + - $ref: [#/definitions/collectionInfo](#/definitions/collectionInfo) + + +## Definitions +**_collectionInfo_** + + - Collection Info. + - Type: `object` + - **_Properties_** + - name + - Unique name that identifies a collection. + - Type: `string` + - documentation + - Description of collection. + - Type: `string` + - href + - URL of the API endpoint where given collections are available. + - Type: `string` + - String format must be a "uri" + - images + - $ref: [profile.json#/definitions/imageList](#profile.jsondefinitionsimagelist) + + + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/collectiondescriptor.md b/docs/openmetadata-apis/schemas/types/collectiondescriptor.md deleted file mode 100644 index 36092b596eb..00000000000 --- a/docs/openmetadata-apis/schemas/types/collectiondescriptor.md +++ /dev/null @@ -1,275 +0,0 @@ -# Collection Descriptor Type - -## collectiondescriptor - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json -``` - -Type used for capturing the details of a collection - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [collectionDescriptor.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### Schema for collection descriptor Type - -`object` \([Schema for collection descriptor](collectiondescriptor.md)\) - -## Schema for collection descriptor Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [collection](collectiondescriptor.md#collection) | `object` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo) | - -### collection - -Collection Info - -`collection` - -* is optional -* Type: `object` \([Details](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo)\) -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo) - -#### collection Type - -`object` \([Details](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo)\) - -## Schema for collection descriptor Definitions - -### Definitions group collectionInfo - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/definitions/collectionInfo"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [name](collectiondescriptor.md#name) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-name) | -| [documentation](collectiondescriptor.md#documentation) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-documentation) | -| [href](collectiondescriptor.md#href) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-href) | -| [images](collectiondescriptor.md#images) | `object` | Optional | cannot be null | [Profile type](profile.md#profile-definitions-imagelist) | - -#### name - -Unique name that identifies a collection - -`name` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-name) - -**name Type** - -`string` - -#### documentation - -Description of collection - -`documentation` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-documentation) - -**documentation Type** - -`string` - -#### href - -URL of the API endpoint where given collections are available - -`href` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-href) - -**href Type** - -`string` - -**href Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### images - -Links to list of images of varying resolutions/sizes - -`images` - -* is optional -* Type: `object` \([Details](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/profile-definitions-imagelist.md)\) -* cannot be null -* defined in: [Profile type](profile.md#profile-definitions-imagelist) - -**images Type** - -`object` \([Details](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/profile-definitions-imagelist.md)\) - -## collectiondescriptor-definitions-collectioninfo-properties-documentation - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/definitions/collectionInfo/properties/documentation -``` - -Description of collection - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [collectionDescriptor.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### documentation Type - -`string` - -## collectiondescriptor-definitions-collectioninfo-properties-href - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/definitions/collectionInfo/properties/href -``` - -URL of the API endpoint where given collections are available - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [collectionDescriptor.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### href Type - -`string` - -### href Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## collectiondescriptor-definitions-collectioninfo-properties-name - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/definitions/collectionInfo/properties/name -``` - -Unique name that identifies a collection - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [collectionDescriptor.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### name Type - -`string` - -## collectiondescriptor-definitions-collectioninfo - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/properties/collection -``` - -Collection Info - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [collectionDescriptor.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### collection Type - -`object` \([Details](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo)\) - -## collection Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [name](collectiondescriptor.md#name) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-name) | -| [documentation](collectiondescriptor.md#documentation) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-documentation) | -| [href](collectiondescriptor.md#href) | `string` | Optional | cannot be null | [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-href) | -| [images](collectiondescriptor.md#images) | `object` | Optional | cannot be null | [Profile type](profile.md#profile-definitions-imagelist) | - -### name - -Unique name that identifies a collection - -`name` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-name) - -#### name Type - -`string` - -### documentation - -Description of collection - -`documentation` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-documentation) - -#### documentation Type - -`string` - -### href - -URL of the API endpoint where given collections are available - -`href` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Schema for collection descriptor](collectiondescriptor.md#collectiondescriptor-definitions-collectioninfo-properties-href) - -#### href Type - -`string` - -#### href Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### images - -Links to list of images of varying resolutions/sizes - -`images` - -* is optional -* Type: `object` \([Details](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/profile-definitions-imagelist.md)\) -* cannot be null -* defined in: [Profile type](profile.md#profile-definitions-imagelist) - -#### images Type - -`object` \([Details](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/profile-definitions-imagelist.md)\) - -## collectiondescriptor-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [collectionDescriptor.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json) | - -### definitions Type - -unknown - diff --git a/docs/openmetadata-apis/schemas/types/dailyCount.md b/docs/openmetadata-apis/schemas/types/dailyCount.md new file mode 100644 index 00000000000..de58b4a1e1a --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/dailyCount.md @@ -0,0 +1,17 @@ +# Daily count of some measurement + +This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json + +Type: `object` + +## Properties + - count `required` + - Daily count of a measurement on the given date. + - Type: `integer` + - Range: ≥ 0 + - date `required` + - $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate) + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/dailycount.md b/docs/openmetadata-apis/schemas/types/dailycount.md deleted file mode 100644 index a74a29fffd6..00000000000 --- a/docs/openmetadata-apis/schemas/types/dailycount.md +++ /dev/null @@ -1,83 +0,0 @@ -# Daily Count Type - -## dailycount - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json -``` - -Type used for capturing and reporting daily count of some measurement, such as usage, joins - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [dailyCount.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json) | - -### Daily count of some measurement Type - -`object` \([Daily count of some measurement](dailycount.md)\) - -## Daily count of some measurement Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [count](dailycount.md#count) | `integer` | Required | cannot be null | [Daily count of some measurement](dailycount.md#dailycount-properties-count) | -| [date](dailycount.md#date) | `string` | Required | cannot be null | [Basic type](basic.md#basic-definitions-date) | - -### count - -Daily count of a measurement on the given date - -`count` - -* is required -* Type: `integer` -* cannot be null -* defined in: [Daily count of some measurement](dailycount.md#dailycount-properties-count) - -#### count Type - -`integer` - -#### count Constraints - -**minimum**: the value of this number must greater than or equal to: `0` - -### date - -Date in ISO 8601 format in UTC time. Example - '2018-11-13' - -`date` - -* is required -* Type: `string` -* cannot be null -* defined in: [Basic type](basic.md#basic-definitions-date) - -#### date Type - -`string` - -#### date Constraints - -**date**: the string must be a date string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339) - -## dailycount-properties-count - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json#/properties/count -``` - -Daily count of a measurement on the given date - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dailyCount.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json) | - -### count Type - -`integer` - -### count Constraints - -**minimum**: the value of this number must greater than or equal to: `0` - diff --git a/docs/openmetadata-apis/schemas/types/entity-usage-type.md b/docs/openmetadata-apis/schemas/types/entity-usage-type.md deleted file mode 100644 index 233bf727fb4..00000000000 --- a/docs/openmetadata-apis/schemas/types/entity-usage-type.md +++ /dev/null @@ -1,2 +0,0 @@ -# Entity Usage Type - diff --git a/docs/openmetadata-apis/schemas/types/entityReference.md b/docs/openmetadata-apis/schemas/types/entityReference.md new file mode 100644 index 00000000000..38bc4b32da4 --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/entityReference.md @@ -0,0 +1,36 @@ +# Entity Reference + +This schema defines the type Entity Reference used for referencing an entity. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies an entity instance. + - $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid) + - type `required` + - Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... + - Type: `string` + - name + - Name of the entity instance. + - Type: `string` + - description + - Optional description of entity. + - Type: `string` + - href + - Link to the entity resource. + - $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref) + + +## Definitions +**_entityReferenceList_** + + - Type: `array` + - **_Items_** + - $ref: [entityReference.json](#entityreference.json) + + + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityUsage.md b/docs/openmetadata-apis/schemas/types/entityUsage.md new file mode 100644 index 00000000000..8ed54f78f1b --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/entityUsage.md @@ -0,0 +1,19 @@ +# Usage details of an entity + +This schema defines type used for capturing usage details of an entity. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json + +Type: `object` + +## Properties + - entity `required` + - Entity for which usage is returned. + - $ref: [entityReference.json](#entityreference.json) + - usage `required` + - List usage details per day. + - Type: `array` + - **_Items_** + - $ref: [usageDetails.json](#usagedetails.json) + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityreference.md b/docs/openmetadata-apis/schemas/types/entityreference.md deleted file mode 100644 index c1d7822d58c..00000000000 --- a/docs/openmetadata-apis/schemas/types/entityreference.md +++ /dev/null @@ -1,205 +0,0 @@ -# Entity Reference Type - -## entityreference - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json -``` - -Entity reference that includes entity ID and entity type - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [entityReference.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) | - -### Entity Reference Type - -`object` \([Entity Reference](entityreference.md)\) - -## Entity Reference Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [id](entityreference.md#id) | `string` | Required | cannot be null | [Basic type](basic.md#basic-definitions-uuid) | -| [type](entityreference.md#type) | `string` | Required | cannot be null | [Entity Reference](entityreference.md#entityreference-properties-type) | -| [name](entityreference.md#name) | `string` | Optional | cannot be null | [Entity Reference](entityreference.md#entityreference-properties-name) | -| [description](entityreference.md#description) | `string` | Optional | cannot be null | [Entity Reference](entityreference.md#entityreference-properties-description) | -| [href](entityreference.md#href) | `string` | Optional | cannot be null | [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-href.md) | - -### id - -Unique id used to identify an entity - -`id` - -* is required -* Type: `string` -* cannot be null -* defined in: [Basic type](basic.md#basic-definitions-uuid) - -#### id Type - -`string` - -#### id Constraints - -**UUID**: the string must be a UUID, according to [RFC 4122](https://tools.ietf.org/html/rfc4122) - -### type - -Entity type/class name - Examples: database, table, metrics, redshift, mysql, bigquery, snowflake... - -`type` - -* is required -* Type: `string` -* cannot be null -* defined in: [Entity Reference](entityreference.md#entityreference-properties-type) - -#### type Type - -`string` - -### name - -Name of the entity instance - -`name` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Entity Reference](entityreference.md#entityreference-properties-name) - -#### name Type - -`string` - -### description - -Optional description of entity - -`description` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Entity Reference](entityreference.md#entityreference-properties-description) - -#### description Type - -`string` - -### href - -Link to the entity resource - -> Link to the resource - -`href` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-href.md) - -#### href Type - -`string` - -#### href Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## Entity Reference Definitions - -### Definitions group entityReferenceList - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/definitions/entityReferenceList"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -## entityreference-definitions-entityreferencelist - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json#/properties/followers -``` - -Followers of this table - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [table.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json) | - -### followers Type - -`object[]` \([Entity Reference](entityreference.md)\) - -## entityreference-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [entityReference.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) | - -### definitions Type - -unknown - -## entityreference-properties-description - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/properties/description -``` - -Optional description of entity - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [entityReference.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) | - -### description Type - -`string` - -## entityreference-properties-name - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/properties/name -``` - -Name of the entity instance - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [entityReference.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) | - -### name Type - -`string` - -## entityreference-properties-type - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/properties/type -``` - -Entity type/class name - Examples: database, table, metrics, redshift, mysql, bigquery, snowflake... - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [entityReference.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) | - -### type Type - -`string` - diff --git a/docs/openmetadata-apis/schemas/types/entityusage.md b/docs/openmetadata-apis/schemas/types/entityusage.md deleted file mode 100644 index 7287f2e38c3..00000000000 --- a/docs/openmetadata-apis/schemas/types/entityusage.md +++ /dev/null @@ -1,73 +0,0 @@ -# entityusage - -```txt -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json -``` - -Type used for capturing usage details of an entity - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [entityUsage.json](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json "open original schema") | - -## Usage details of an entity Type - -`object` ([Usage details of an entity](entityusage.md)) - -# Usage details of an entity Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [entity](#entity) | `object` | Required | cannot be null | [Usage details of an entity](entityreference.md "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/properties/entity") | -| [usage](#usage) | `array` | Required | cannot be null | [Usage details of an entity](#entityusage-properties-usage "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json#/properties/usage") | - -## entity - -Entity reference that includes entity ID and entity type - -`entity` - -* is required - -* Type: `object` ([Entity Reference](entityreference.md)) - -* cannot be null - -* defined in: [Usage details of an entity](entityreference.md "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json#/properties/entity") - -### entity Type - -`object` ([Entity Reference](entityreference.md)) - -## usage - -List usage details per day - -`usage` - -* is required - -* Type: `object[]` ([Type used to return usage details of an entity](usagedetails.md)) - -* cannot be null - -* defined in: [Usage details of an entity](#entityusage-properties-usage "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json#/properties/usage") - -### usage Type - -`object[]` ([Type used to return usage details of an entity](usagedetails.md)) -# entityusage-properties-usage - -```txt -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json#/properties/usage -``` - -List usage details per day - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [entityUsage.json*](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json "open original schema") | - -## usage Type - -`object[]` ([Type used to return usage details of an entity](usagedetails.md)) diff --git a/docs/openmetadata-apis/schemas/types/jdbcConnection.md b/docs/openmetadata-apis/schemas/types/jdbcConnection.md new file mode 100644 index 00000000000..7d5ea2a61fe --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/jdbcConnection.md @@ -0,0 +1,51 @@ +# JDBC connection + +JDBC connection information + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json + +Type: `object` + +## Properties + - driverClass `required` + - JDBC driver class + - $ref: [#/definitions/driverClass](#/definitions/driverClass) + - connectionUrl `required` + - JDBC connection URL + - $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl) + - userName `required` + - Login user name. + - Type: `string` + - password `required` + - Login password. + - Type: `string` + + +## Definitions +**_driverClass_** + + - Type used for JDBC driver class + - Type: `string` + + +**_connectionUrl_** + + - Type used for JDBC connection URL + - Type: `string` + - String format must be a "uri" + + +**_jdbcInfo_** + + - Type for capturing JDBC connector information + - Type: `object` + - **_Properties_** + - driverClass `required` + - $ref: [#/definitions/driverClass](#/definitions/driverClass) + - Default: _"com.amazon.redshift.jdbc42.Driver"_ + - connectionUrl `required` + - $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl) + + + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/jdbcconnection.md b/docs/openmetadata-apis/schemas/types/jdbcconnection.md deleted file mode 100644 index 0ae23f7546a..00000000000 --- a/docs/openmetadata-apis/schemas/types/jdbcconnection.md +++ /dev/null @@ -1,365 +0,0 @@ -# Jdbc Connection Type - -## jdbcconnection - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json -``` - -JDBC connection information used for connecting to a database system - -> JDBC connection information - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [jdbcConnection.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### JDBC connection Type - -`object` \([JDBC connection](jdbcconnection.md)\) - -## JDBC connection Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [driverClass](jdbcconnection.md#driverclass) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-properties-driverclass) | -| [connectionUrl](jdbcconnection.md#connectionurl) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-properties-connectionurl) | -| [userName](jdbcconnection.md#username) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-properties-username) | -| [password](jdbcconnection.md#password) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-properties-password) | - -### driverClass - -> Type used for JDBC driver class - -`driverClass` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-properties-driverclass) - -#### driverClass Type - -`string` - -### connectionUrl - -> Type used for JDBC connection URL - -`connectionUrl` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-properties-connectionurl) - -#### connectionUrl Type - -`string` - -#### connectionUrl Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### userName - -Login user name - -`userName` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-properties-username) - -#### userName Type - -`string` - -### password - -Login password - -`password` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-properties-password) - -#### password Type - -`string` - -## JDBC connection Definitions - -### Definitions group driverClass - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions/driverClass"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -### Definitions group connectionUrl - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions/connectionUrl"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | - - -### Definitions group jdbcInfo - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions/jdbcInfo"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [driverClass](jdbcconnection.md#driverclass-1) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-driverclass) | -| [connectionUrl](jdbcconnection.md#connectionurl-1) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-connectionurl) | - -#### driverClass - -> Type used for JDBC driver class - -`driverClass` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-driverclass) - -**driverClass Type** - -`string` - -**driverClass Default Value** - -The default value is: - -```javascript -"com.amazon.redshift.jdbc42.Driver" -``` - -#### connectionUrl - -> Type used for JDBC connection URL - -`connectionUrl` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-connectionurl) - -**connectionUrl Type** - -`string` - -**connectionUrl Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## jdbcconnection-definitions-connectionurl - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions/jdbcInfo/properties/connectionUrl -``` - -> Type used for JDBC connection URL - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### connectionUrl Type - -`string` - -### connectionUrl Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## jdbcconnection-definitions-driverclass - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions/jdbcInfo/properties/driverClass -``` - -> Type used for JDBC driver class - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### driverClass Type - -`string` - -### driverClass Default Value - -The default value is: - -```javascript -"com.amazon.redshift.jdbc42.Driver" -``` - -## jdbcconnection-definitions-jdbcinfo - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/services/updateDatabaseService.json#/properties/jdbc -``` - -> Type for capturing JDBC connector information - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [updateDatabaseService.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/services/updateDatabaseService.json) | - -### jdbc Type - -`object` \([Details](jdbcconnection.md#jdbcconnection-definitions-jdbcinfo)\) - -## jdbc Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [driverClass](jdbcconnection.md#driverclass) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-driverclass) | -| [connectionUrl](jdbcconnection.md#connectionurl) | `string` | Required | cannot be null | [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-connectionurl) | - -### driverClass - -> Type used for JDBC driver class - -`driverClass` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-driverclass) - -#### driverClass Type - -`string` - -#### driverClass Default Value - -The default value is: - -```javascript -"com.amazon.redshift.jdbc42.Driver" -``` - -### connectionUrl - -> Type used for JDBC connection URL - -`connectionUrl` - -* is required -* Type: `string` -* cannot be null -* defined in: [JDBC connection](jdbcconnection.md#jdbcconnection-definitions-connectionurl) - -#### connectionUrl Type - -`string` - -#### connectionUrl Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## jdbcconnection-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### definitions Type - -unknown - -## jdbcconnection-properties-connectionurl - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/properties/connectionUrl -``` - -> Type used for JDBC connection URL - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### connectionUrl Type - -`string` - -### connectionUrl Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## jdbcconnection-properties-driverclass - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/properties/driverClass -``` - -> Type used for JDBC driver class - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### driverClass Type - -`string` - -## jdbcconnection-properties-password - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/properties/password -``` - -Login password - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### password Type - -`string` - -## jdbcconnection-properties-username - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json#/properties/userName -``` - -Login user name - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [jdbcConnection.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) | - -### userName Type - -`string` - diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 5039c59a468..93675603c09 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -1,465 +1,44 @@ -# Profile Type - -## profile - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json -``` - -Type used to capture profile of a user, team, or an organization - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [profile.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### Type used to capture profile of a user, team, or an organization Type - -`object` \([Type used to capture profile of a user, team, or an organization](profile.md)\) - -## Type used to capture profile of a user, team, or an organization Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [images](profile.md#images) | `object` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist) | - -### images - -Links to list of images of varying resolutions/sizes - -`images` - -* is optional -* Type: `object` \([Details](profile.md#profile-definitions-imagelist)\) -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist) - -#### images Type - -`object` \([Details](profile.md#profile-definitions-imagelist)\) - -## Type used to capture profile of a user, team, or an organization Definitions - -### Definitions group imageList - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [image](profile.md#image) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image) | -| [image24](profile.md#image24) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image24) | -| [image32](profile.md#image32) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image32) | -| [image48](profile.md#image48) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image48) | -| [image72](profile.md#image72) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image72) | -| [image192](profile.md#image192) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image192) | -| [image512](profile.md#image512) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image512) | - -#### image - -`image` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image) - -**image Type** - -`string` - -**image Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image24 - -`image24` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image24) - -**image24 Type** - -`string` - -**image24 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image32 - -`image32` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image32) - -**image32 Type** - -`string` - -**image32 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image48 - -`image48` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image48) - -**image48 Type** - -`string` - -**image48 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image72 - -`image72` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image72) - -**image72 Type** - -`string` - -**image72 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image192 - -`image192` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image192) - -**image192 Type** - -`string` - -**image192 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -#### image512 - -`image512` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image512) - -**image512 Type** - -`string` - -**image512 Constraints** - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image Type - -`string` - -### image Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image192 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image192 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image192 Type - -`string` - -### image192 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image24 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image24 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image24 Type - -`string` - -### image24 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image32 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image32 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image32 Type - -`string` - -### image32 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image48 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image48 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image48 Type - -`string` - -### image48 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image512 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image512 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image512 Type - -`string` - -### image512 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist-properties-image72 - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions/imageList/properties/image72 -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### image72 Type - -`string` - -### image72 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions-imagelist - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/properties/images -``` - -Links to list of images of varying resolutions/sizes - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### images Type - -`object` \([Details](profile.md#profile-definitions-imagelist)\) - -## images Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [image](profile.md#image) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image) | -| [image24](profile.md#image24) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image24) | -| [image32](profile.md#image32) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image32) | -| [image48](profile.md#image48) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image48) | -| [image72](profile.md#image72) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image72) | -| [image192](profile.md#image192) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image192) | -| [image512](profile.md#image512) | `string` | Optional | cannot be null | [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image512) | - -### image - -`image` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image) - -#### image Type - -`string` - -#### image Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image24 - -`image24` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image24) - -#### image24 Type - -`string` - -#### image24 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image32 - -`image32` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image32) - -#### image32 Type - -`string` - -#### image32 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image48 - -`image48` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image48) - -#### image48 Type - -`string` - -#### image48 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image72 - -`image72` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image72) - -#### image72 Type - -`string` - -#### image72 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image192 - -`image192` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image192) - -#### image192 Type - -`string` - -#### image192 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -### image512 - -`image512` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used to capture profile of a user, team, or an organization](profile.md#profile-definitions-imagelist-properties-image512) - -#### image512 Type - -`string` - -#### image512 Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## profile-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) | - -### definitions Type - -unknown - +# Profile + +This schema defines type used to capture profile of a user, team, or an organization. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json + +Type: `object` + +## Properties + - images + - $ref: [#/definitions/imageList](#/definitions/imageList) + + +## Definitions +**_imageList_** + + - Links to list of images of varying resolutions/sizes. + - Type: `object` + - **_Properties_** + - image + - Type: `string` + - String format must be a "uri" + - image24 + - Type: `string` + - String format must be a "uri" + - image32 + - Type: `string` + - String format must be a "uri" + - image48 + - Type: `string` + - String format must be a "uri" + - image72 + - Type: `string` + - String format must be a "uri" + - image192 + - Type: `string` + - String format must be a "uri" + - image512 + - Type: `string` + - String format must be a "uri" + + + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index 97ee73be796..7fc6d936656 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -1,61 +1,17 @@ -# Schedule Type +# Type used for schedule with start time and repeat frequency -## schedule +This schema defines type used for Schedule with start time and repeat frequency. -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json -``` +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json -Type used for schedule with start time and repeat frequency +Type: `object` -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [schedule.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json) | - -### Type used for schedule with start time and repeat frequency Type - -`object` \([Type used for schedule with start time and repeat frequency](schedule.md)\) - -## Type used for schedule with start time and repeat frequency Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [startDate](schedule.md#startdate) | `string` | Optional | cannot be null | [Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-datetime.md) | -| [repeatFrequency](schedule.md#repeatfrequency) | `string` | Optional | cannot be null | [Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-duration.md) | - -### startDate - -Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00' - -`startDate` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-datetime.md) - -#### startDate Type - -`string` - -#### startDate Constraints - -**unknown format**: the value of this string must follow the format: `date-Time` - -### repeatFrequency - -Duration in ISO 8601 format in UTC time. Example - 'P23DT23H' - -> Jsonschema does not handle ISO 8601 duration yet and hence no format for this type - -`repeatFrequency` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Type used for schedule with start time and repeat frequency](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-duration.md) - -#### repeatFrequency Type - -`string` +## Properties + - startDate + - Start date and time of the schedule. + - $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime) + - repeatFrequency + - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H' + - $ref: [basic.json#/definitions/duration](#basic.jsondefinitionsduration) +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/tagLabel.md b/docs/openmetadata-apis/schemas/types/tagLabel.md new file mode 100644 index 00000000000..1ecb218150d --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/tagLabel.md @@ -0,0 +1,31 @@ +# Tag Label + +This schema defines type used for labeling an entity or an entity field with a Tag. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json + +Type: `object` + +## Properties + - tagFQN + - Type: `string` + - Length: ≤ 45 + - labelType + - Type: `string` + - The value is restricted to the following: + 1. _"Manual"_ + 2. _"Propagated"_ + 3. _"Automated"_ + 4. _"Derived"_ + - Default: _"Manual"_ + - state + - Type: `string` + - The value is restricted to the following: + 1. _"Suggested"_ + 2. _"Confirmed"_ + - Default: _"Confirmed"_ + - href + - Link to the tag resource. + - $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref) + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/taglabel.md b/docs/openmetadata-apis/schemas/types/taglabel.md deleted file mode 100644 index 53c19f3f636..00000000000 --- a/docs/openmetadata-apis/schemas/types/taglabel.md +++ /dev/null @@ -1,209 +0,0 @@ -# Tag Label Type - -## taglabel - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json -``` - -Type used for schedule with start time and repeat frequency - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [tagLabel.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json) | - -### Tag Label Type - -`object` \([Tag Label](taglabel.md)\) - -## Tag Label Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [tagFQN](taglabel.md#tagfqn) | `string` | Optional | cannot be null | [Tag Label](taglabel.md#taglabel-properties-tagfqn) | -| [labelType](taglabel.md#labeltype) | `string` | Optional | cannot be null | [Tag Label](taglabel.md#taglabel-properties-labeltype) | -| [state](taglabel.md#state) | `string` | Optional | cannot be null | [Tag Label](taglabel.md#taglabel-properties-state) | -| [href](taglabel.md#href) | `string` | Optional | cannot be null | [Tag Label](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-href.md) | - -### tagFQN - -`tagFQN` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Tag Label](taglabel.md#taglabel-properties-tagfqn) - -#### tagFQN Type - -`string` - -#### tagFQN Constraints - -**maximum length**: the maximum number of characters for this string is: `45` - -### labelType - -`labelType` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Tag Label](taglabel.md#taglabel-properties-labeltype) - -#### labelType Type - -`string` - -#### labelType Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :--- | :--- | -| `"Manual"` | | -| `"Propagated"` | | -| `"Automated"` | | -| `"Derived"` | | - -#### labelType Default Value - -The default value is: - -```javascript -"Manual" -``` - -### state - -`state` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Tag Label](taglabel.md#taglabel-properties-state) - -#### state Type - -`string` - -#### state Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :--- | :--- | -| `"Suggested"` | | -| `"Confirmed"` | | - -#### state Default Value - -The default value is: - -```javascript -"Confirmed" -``` - -### href - -Link to the tag resource - -> Link to the resource - -`href` - -* is optional -* Type: `string` -* cannot be null -* defined in: [Tag Label](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/types/basic-definitions-href.md) - -#### href Type - -`string` - -#### href Constraints - -**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986) - -## taglabel-properties-labeltype - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json#/properties/labelType -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [tagLabel.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json) | - -### labelType Type - -`string` - -### labelType Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :--- | :--- | -| `"Manual"` | | -| `"Propagated"` | | -| `"Automated"` | | -| `"Derived"` | | - -### labelType Default Value - -The default value is: - -```javascript -"Manual" -``` - -## taglabel-properties-state - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json#/properties/state -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [tagLabel.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json) | - -### state Type - -`string` - -### state Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :--- | :--- | -| `"Suggested"` | | -| `"Confirmed"` | | - -### state Default Value - -The default value is: - -```javascript -"Confirmed" -``` - -## taglabel-properties-tagfqn - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json#/properties/tagFQN -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [tagLabel.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json) | - -### tagFQN Type - -`string` - -### tagFQN Constraints - -**maximum length**: the maximum number of characters for this string is: `45` - diff --git a/docs/openmetadata-apis/schemas/types/usageDetails.md b/docs/openmetadata-apis/schemas/types/usageDetails.md new file mode 100644 index 00000000000..e646d8671dd --- /dev/null +++ b/docs/openmetadata-apis/schemas/types/usageDetails.md @@ -0,0 +1,42 @@ +# Type used to return usage details of an entity + +This schema defines type used for capturing usage details of an entity. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json + +Type: `object` + +## Properties + - dailyStats `required` + - Daily usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - weeklyStats + - Weekly (last 7 days) rolling usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - monthlyStats + - Monthly (last 30 days) rolling usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - date `required` + - Date in UTC time. + - $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate) + + +## Definitions +**_usageStats_** + + - Type used to return usage statistics + - Type: `object` + - This schema does not accept additional properties. + - **_Properties_** + - count `required` + - Usage count of a data asset on the start date. + - Type: `integer` + - Range: ≥ 0 + - percentileRank + - Optional daily percentile rank data asset use when relevant. + - Type: `number` + - Range: between 0 and 100 + + + +_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/usagedetails.md b/docs/openmetadata-apis/schemas/types/usagedetails.md deleted file mode 100644 index c0fc223465f..00000000000 --- a/docs/openmetadata-apis/schemas/types/usagedetails.md +++ /dev/null @@ -1,253 +0,0 @@ -# Usage Details Type - -## usagedetails - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json -``` - -Type used to return usage details of an entity - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [usageDetails.json](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/type/usageDetails.json) | - -### Type used to return usage details of an entity Type - -`object` \([Type used to return usage details of an entity](usagedetails.md)\) - -## Type used to return usage details of an entity Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [dailyStats](usagedetails.md#dailystats) | `object` | Required | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) | -| [weeklyStats](usagedetails.md#weeklystats) | `object` | Optional | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) | -| [monthlyStats](usagedetails.md#monthlystats) | `object` | Optional | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) | -| [date](usagedetails.md#date) | `string` | Required | cannot be null | [Basic type](basic.md#basic-definitions-date) | - -### dailyStats - -> Type used to return usage statistics - -`dailyStats` - -* is required -* Type: `object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) - -#### dailyStats Type - -`object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) - -### weeklyStats - -> Type used to return usage statistics - -`weeklyStats` - -* is optional -* Type: `object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) - -#### weeklyStats Type - -`object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) - -### monthlyStats - -> Type used to return usage statistics - -`monthlyStats` - -* is optional -* Type: `object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats) - -#### monthlyStats Type - -`object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) - -### date - -Date in ISO 8601 format in UTC time. Example - '2018-11-13' - -`date` - -* is required -* Type: `string` -* cannot be null -* defined in: [Basic type](basic.md#basic-definitions-date) - -#### date Type - -`string` - -#### date Constraints - -**date**: the string must be a date string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339) - -## Type used to return usage details of an entity Definitions - -### Definitions group usageStats - -Reference this group by using - -```javascript -{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json#/definitions/usageStats"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [count](usagedetails.md#count) | `integer` | Required | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-count) | -| [percentileRank](usagedetails.md#percentilerank) | `number` | Optional | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-percentilerank) | - -#### count - -`count` - -* is required -* Type: `integer` -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-count) - -**count Type** - -`integer` - -**count Constraints** - -**minimum**: the value of this number must greater than or equal to: `0` - -#### percentileRank - -`percentileRank` - -* is optional -* Type: `number` -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-percentilerank) - -**percentileRank Type** - -`number` - -**percentileRank Constraints** - -**maximum**: the value of this number must smaller than or equal to: `100` - -**minimum**: the value of this number must greater than or equal to: `0` - -## usagedetails-definitions-usagestats-properties-count - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json#/definitions/usageStats/properties/count -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [usageDetails.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/type/usageDetails.json) | - -### count Type - -`integer` - -### count Constraints - -**minimum**: the value of this number must greater than or equal to: `0` - -## usagedetails-definitions-usagestats-properties-percentilerank - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json#/definitions/usageStats/properties/percentileRank -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [usageDetails.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/type/usageDetails.json) | - -### percentileRank Type - -`number` - -### percentileRank Constraints - -**maximum**: the value of this number must smaller than or equal to: `100` - -**minimum**: the value of this number must greater than or equal to: `0` - -## usagedetails-definitions-usagestats - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json#/properties/monthlyStats -``` - -> Type used to return usage statistics - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [usageDetails.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/type/usageDetails.json) | - -### monthlyStats Type - -`object` \([Details](usagedetails.md#usagedetails-definitions-usagestats)\) - -## monthlyStats Properties - -| Property | Type | Required | Nullable | Defined by | -| :--- | :--- | :--- | :--- | :--- | -| [count](usagedetails.md#count) | `integer` | Required | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-count) | -| [percentileRank](usagedetails.md#percentilerank) | `number` | Optional | cannot be null | [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-percentilerank) | - -### count - -`count` - -* is required -* Type: `integer` -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-count) - -#### count Type - -`integer` - -#### count Constraints - -**minimum**: the value of this number must greater than or equal to: `0` - -### percentileRank - -`percentileRank` - -* is optional -* Type: `number` -* cannot be null -* defined in: [Type used to return usage details of an entity](usagedetails.md#usagedetails-definitions-usagestats-properties-percentilerank) - -#### percentileRank Type - -`number` - -#### percentileRank Constraints - -**maximum**: the value of this number must smaller than or equal to: `100` - -**minimum**: the value of this number must greater than or equal to: `0` - -## usagedetails-definitions - -```text -https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json#/definitions -``` - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [usageDetails.json\*](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/out/type/usageDetails.json) | - -### definitions Type - -unknown -