updated the json schema doc and metadata-ingestion doc (#768)

Co-authored-by: Parth Panchal <parthpanchal@Parths-MacBook-Air.local>
This commit is contained in:
parthp2107 2021-10-14 16:19:34 +05:30 committed by GitHub
parent bf56851fd3
commit edd43f30ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
52 changed files with 197 additions and 48 deletions

View File

@ -74,7 +74,6 @@
* [Connectors](install/metadata-ingestion/connectors/README.md) * [Connectors](install/metadata-ingestion/connectors/README.md)
* [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md) * [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md)
* [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md) * [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md)
* [Salesforce](install/metadata-ingestion/connectors/database-services/salesforce.md)
* [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md) * [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md)
* [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md) * [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md)
* [Database Services](install/metadata-ingestion/connectors/database-services/README.md) * [Database Services](install/metadata-ingestion/connectors/database-services/README.md)
@ -87,11 +86,12 @@
* [Oracle](install/metadata-ingestion/connectors/database-services/oracle.md) * [Oracle](install/metadata-ingestion/connectors/database-services/oracle.md)
* [Postgres](install/metadata-ingestion/connectors/database-services/postgres.md) * [Postgres](install/metadata-ingestion/connectors/database-services/postgres.md)
* [Presto](install/metadata-ingestion/connectors/database-services/presto.md) * [Presto](install/metadata-ingestion/connectors/database-services/presto.md)
* [Trino](install/metadata-ingestion/connectors/database-services/trino.md)
* [Redshift](install/metadata-ingestion/connectors/database-services/redshift.md)
* [Redshift Usage](install/metadata-ingestion/connectors/database-services/redshift-usage.md) * [Redshift Usage](install/metadata-ingestion/connectors/database-services/redshift-usage.md)
* [Salesforce](install/metadata-ingestion/connectors/database-services/salesforce.md)
* [Snowflake](install/metadata-ingestion/connectors/database-services/snowflake.md) * [Snowflake](install/metadata-ingestion/connectors/database-services/snowflake.md)
* [Snowflake Usage](install/metadata-ingestion/connectors/database-services/snowflake-usage.md) * [Snowflake Usage](install/metadata-ingestion/connectors/database-services/snowflake-usage.md)
* [Trino](install/metadata-ingestion/connectors/database-services/trino.md)
* [Vertica](install/metadata-ingestion/connectors/database-services/vertica.md)
* [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md) * [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md)
* [Kafka](install/metadata-ingestion/connectors/messaging-services/kafka.md) * [Kafka](install/metadata-ingestion/connectors/messaging-services/kafka.md)
* [Scheduler](install/metadata-ingestion/scheduler.md) * [Scheduler](install/metadata-ingestion/scheduler.md)

View File

@ -4,8 +4,6 @@ OpenMetadata supports connectors to some popular dashboard services. We will con
{% page-ref page="looker.md" %} {% page-ref page="looker.md" %}
{% page-ref page="salesforce.md" %}
{% page-ref page="superset.md" %} {% page-ref page="superset.md" %}
{% page-ref page="tableau.md" %} {% page-ref page="tableau.md" %}

View File

@ -10,6 +10,7 @@ description: This guide will help install Looker connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source
@ -61,7 +62,6 @@ Add Optionally`pii` processor and `metadata-rest-tables` sink along with `metada
{% code title="looker.json" %} {% code title="looker.json" %}
```javascript ```javascript
{ {
{
"source": { "source": {
"type": "looker", "type": "looker",
"config": { "config": {

View File

@ -10,6 +10,7 @@ description: This guide will help install Superset connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Tableau connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -8,6 +8,8 @@ OpenMetadata supports connectors to some popular data sources. We will continue
{% page-ref page="elastic-search.md" %} {% page-ref page="elastic-search.md" %}
{% page-ref page="hive.md" %}
{% page-ref page="mssql.md" %} {% page-ref page="mssql.md" %}
{% page-ref page="mysql.md" %} {% page-ref page="mysql.md" %}
@ -16,13 +18,17 @@ OpenMetadata supports connectors to some popular data sources. We will continue
{% page-ref page="postgres.md" %} {% page-ref page="postgres.md" %}
{% page-ref page="redshift.md" %}
{% page-ref page="redshift-usage.md" %} {% page-ref page="redshift-usage.md" %}
{% page-ref page="salesforce.md" %}
{% page-ref page="snowflake.md" %} {% page-ref page="snowflake.md" %}
{% page-ref page="snowflake-usage.md" %} {% page-ref page="snowflake-usage.md" %}
{% page-ref page="trino.md" %}
{% page-ref page="vertica.md" %}

View File

@ -10,6 +10,7 @@ description: This guide will help install Athena connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install BigQuery connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -12,6 +12,7 @@ description: >-
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -9,6 +9,7 @@ description: This guide will help install Hive connector and run manually
1. Python 3.7 or above 1. Python 3.7 or above
2. Library: **libsasl2-dev** Hive connector uses `pyhive` to connect and fetch metadata. Pyhive has python sasl dependency and which requires libsasl2-dev to be installed. In some cases, you may need to set LD\_LIBRARY\_PATH to point to where libsasl2-dev is installed. Please check on how to install libsasl2 for your Linux Distro. 2. Library: **libsasl2-dev** Hive connector uses `pyhive` to connect and fetch metadata. Pyhive has python sasl dependency and which requires libsasl2-dev to be installed. In some cases, you may need to set LD\_LIBRARY\_PATH to point to where libsasl2-dev is installed. Please check on how to install libsasl2 for your Linux Distro.
3. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source
@ -78,7 +79,6 @@ Add optionally `pii` processor and `metadata-rest-tables` sink along with `metad
} }
} }
``` ```
{% endcode %} {% endcode %}

View File

@ -10,6 +10,7 @@ description: This guide will help install MsSQL connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install MySQL connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Oracle connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Postgres connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Redshift Usage connector and run manua
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Salesforce connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Snowflake Usage connector and run manu
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -10,6 +10,7 @@ description: This guide will help install Snowflake connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -34,12 +34,13 @@ metadata ingest -c ./examples/workflows/trino.json
{% code title="trino.json" %} {% code title="trino.json" %}
```javascript ```javascript
{
"source": { "source": {
"type": "trino", "type": "trino",
"config": { "config": {
"service_name": "local_trino", "service_name": "local_trino",
"host_port": "192.168.1.32:8080", "host_port": "localhost:8080",
"database": "default" "catalog": "system"
} }
}, ... }, ...
``` ```
@ -63,11 +64,11 @@ add `metadata-rest-tables` sink along with `metadata-server` config
```javascript ```javascript
{ {
"source": { "source": {
"type": "Trino", "type": "trino",
"config": { "config": {
"service_name": "local_trino", "service_name": "local_trino",
"host_port": "192.168.1.32:8080", "host_port": "localhost:8080",
"database": "default" "catalog": "system"
} }
}, },
"sink": { "sink": {

View File

@ -0,0 +1,100 @@
---
description: This guide will help install Vertica Usage connector and run manually
---
# Vertica Usage
{% hint style="info" %}
**Prerequisites**
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %}
### Install from PyPI or Source
{% tabs %}
{% tab title="Install Using PyPI" %}
```bash
pip install 'openmetadata-ingestion[vertica]'
```
{% endtab %}
{% endtabs %}
## Run Manually
```bash
metadata ingest -c ./examples/workflows/vertica.json
```
### Configuration
{% code title="vertica.json" %}
```javascript
{
"source": {
"type": "vertica",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_vertica",
"filter_pattern": {
"excludes": []
}
}
},
```
{% endcode %}
1. **username** - pass the Vertica username.
2. **password** - the password for the Vertica username.
3. **service\_name** - Service Name for this Vertica cluster. If you added the Vertica cluster through OpenMetadata UI, make sure the service name matches the same.
4. **filter\_pattern** - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata.
5. **database -** Database name from where data is to be fetched.
### Publish to OpenMetadata
Below is the configuration to publish Vertica Usage data into the OpenMetadata service.
Add Optionally `query-parser` processor, `table-usage` stage and`metadata-usage` bulk\_sink along with `metadata-server` config
{% code title="vertica.json" %}
```javascript
{
"source": {
"type": "vertica",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_vertica",
"filter_pattern": {
"excludes": []
}
}
},
"sink": {
"type": "metadata-rest",
"config": {}
},
"metadata_server": {
"type": "metadata-server",
"config": {
"api_endpoint": "http://localhost:8585/api",
"auth_provider_type": "no-auth"
}
},
"cron": {
"minute": "*/5",
"hour": null,
"day": null,
"month": null,
"day_of_week": null
}
}
```
{% endcode %}

View File

@ -10,6 +10,7 @@ description: This guide will help install Kafka connector and run manually
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
1. Python 3.7 or above 1. Python 3.7 or above
2. OpenMetadata Server up and running
{% endhint %} {% endhint %}
### Install from PyPI or Source ### Install from PyPI or Source

View File

@ -24,4 +24,4 @@ Type: `object`
- Link to the resource corresponding to this bot. - Link to the resource corresponding to this bot.
- $ref: [../type/basic.json#/definitions/href](../types/basic.md#href) - $ref: [../type/basic.json#/definitions/href](../types/basic.md#href)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -74,4 +74,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -54,4 +54,4 @@ Type: `object`
- Latest usage information for this database. - Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md) - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -14,6 +14,9 @@ Type: `object`
- Name that identifies this dashboard service. - Name that identifies this dashboard service.
- Type: `string` - Type: `string`
- Length: between 1 and 64 - Length: between 1 and 64
- **displayName**
- Display Name that identifies this dashboard service.
- Type: `string`
- **serviceType** `required` - **serviceType** `required`
- Type of dashboard service such as Looker or Superset... - Type of dashboard service such as Looker or Superset...
- $ref: [#/definitions/dashboardServiceType](#dashboardservicetype) - $ref: [#/definitions/dashboardServiceType](#dashboardservicetype)
@ -51,4 +54,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -16,6 +16,9 @@ Type: `object`
- **fullyQualifiedName** - **fullyQualifiedName**
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. - Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- Type: `string` - Type: `string`
- **displayName**
- Display Name that identifies this database.
- Type: `string`
- **description** - **description**
- Description of the database instance. - Description of the database instance.
- Type: `string` - Type: `string`
@ -46,4 +49,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -14,6 +14,9 @@ Type: `object`
- Name that identifies this database service. - Name that identifies this database service.
- Type: `string` - Type: `string`
- Length: between 1 and 64 - Length: between 1 and 64
- **displayName**
- Display Name that identifies this database service.
- Type: `string`
- **serviceType** `required` - **serviceType** `required`
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
- $ref: [#/definitions/databaseServiceType](#databaseservicetype) - $ref: [#/definitions/databaseServiceType](#databaseservicetype)
@ -50,4 +53,4 @@ Type: `object`
11. _"Trino"_ 11. _"Trino"_
12. _"Vertica"_ 12. _"Vertica"_
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -20,6 +20,9 @@ Type: `object`
- **description** - **description**
- Description of a messaging service instance. - Description of a messaging service instance.
- Type: `string` - Type: `string`
- **displayName**
- Display Name that identifies this messaging service. It could be title or label from the source services.
- Type: `string`
- **brokers** `required` - **brokers** `required`
- Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar. - Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
- $ref: [#/definitions/brokers](#brokers) - $ref: [#/definitions/brokers](#brokers)
@ -52,6 +55,4 @@ Type: `object`
- **Items** - **Items**
- Type: `string` - Type: `string`
_This document was updated on: Thursday, October 14, 2021_
_This document was updated on: Tuesday, October 12, 2021_

View File

@ -18,6 +18,9 @@ Type: `object`
- A unique name that identifies a metric in the format 'ServiceName.MetricName'. - A unique name that identifies a metric in the format 'ServiceName.MetricName'.
- Type: `string` - Type: `string`
- Length: between 1 and 64 - Length: between 1 and 64
- **displayName**
- Display Name that identifies this metric.
- Type: `string`
- **description** - **description**
- Description of metrics instance, what it is, and how to use it. - Description of metrics instance, what it is, and how to use it.
- Type: `string` - Type: `string`
@ -34,4 +37,4 @@ Type: `object`
- Latest usage information for this database. - Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md) - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -49,4 +49,4 @@ Type: `object`
- $ref: [../../type/usageDetails.json](../types/usagedetails.md) - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -60,4 +60,4 @@ Type: `object`
- Link to service where this pipeline is hosted in. - Link to service where this pipeline is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md) - $ref: [../../type/entityReference.json](../types/entityreference.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -20,6 +20,9 @@ Type: `object`
- **description** - **description**
- Description of a pipeline service instance. - Description of a pipeline service instance.
- Type: `string` - Type: `string`
- **displayName**
- Display Name that identifies this pipeline service. It could be title or label from the source services.
- Type: `string`
- **pipelineUrl** `required` - **pipelineUrl** `required`
- Pipeline Service Management/UI URL. - Pipeline Service Management/UI URL.
- Type: `string` - Type: `string`
@ -42,4 +45,4 @@ Type: `object`
2. _"Prefect"_ 2. _"Prefect"_
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -18,6 +18,9 @@ Type: `object`
- A unique name that identifies a report in the format 'ServiceName.ReportName'. - A unique name that identifies a report in the format 'ServiceName.ReportName'.
- Type: `string` - Type: `string`
- Length: between 1 and 64 - Length: between 1 and 64
- **displayName**
- Display Name that identifies this report. It could be title or label from the source services.
- Type: `string`
- **description** - **description**
- Description of this report instance. - Description of this report instance.
- Type: `string` - Type: `string`
@ -34,4 +37,4 @@ Type: `object`
- Latest usage information for this database. - Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md) - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -13,6 +13,9 @@ Type: `object`
- **name** `required` - **name** `required`
- Name of a table. Expected to be unique within a database. - Name of a table. Expected to be unique within a database.
- $ref: [#/definitions/tableName](#tablename) - $ref: [#/definitions/tableName](#tablename)
- **displayName**
- Display Name that identifies this table. It could be title or label from the source services.
- Type: `string`
- **description** - **description**
- Description of a table. - Description of a table.
- Type: `string` - Type: `string`
@ -337,4 +340,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -11,6 +11,9 @@ This schema <u>does not</u> accept additional properties.
## Properties ## Properties
- **name** `required` - **name** `required`
- $ref: [#/definitions/tagName](#tagname) - $ref: [#/definitions/tagName](#tagname)
- **displayName**
- Display Name that identifies this tag category.
- Type: `string`
- **description** `required` - **description** `required`
- Description of the tag category. - Description of the tag category.
- Type: `string` - Type: `string`
@ -49,4 +52,4 @@ This schema <u>does not</u> accept additional properties.
### tag ### tag
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -62,4 +62,4 @@ Type: `object`
- $ref: [../../type/entityReference.json](../types/entityreference.md) - $ref: [../../type/entityReference.json](../types/entityreference.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -43,4 +43,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -47,4 +47,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -16,6 +16,9 @@ Type: `object`
- **fullyQualifiedName** - **fullyQualifiedName**
- Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'. - Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'.
- Type: `string` - Type: `string`
- **displayName**
- Display Name that identifies this topic. It could be title or label from the source services.
- Type: `string`
- **description** - **description**
- Description of the topic instance. - Description of the topic instance.
- Type: `string` - Type: `string`
@ -97,4 +100,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -58,5 +58,4 @@ This schema <u>does not</u> accept additional properties.
- Length: between 1 and 64 - Length: between 1 and 64
_This document was updated on: Thursday, October 14, 2021_
_This document was updated on: Tuesday, October 12, 2021_

View File

@ -34,4 +34,4 @@ Type: `object`
- Type of Entity that is modified by the operation. - Type of Entity that is modified by the operation.
- Type: `string` - Type: `string`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -84,4 +84,4 @@ This schema defines basic common types that are used by other schemas.
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -16,4 +16,4 @@ This schema <u>does not</u> accept additional properties.
- **date** `required` - **date** `required`
- $ref: [basic.json#/definitions/date](basic.md#date) - $ref: [basic.json#/definitions/date](basic.md#date)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -57,4 +57,4 @@ This schema <u>does not</u> accept additional properties.
- Type: `string` - Type: `string`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -21,6 +21,9 @@ This schema <u>does not</u> accept additional properties.
- **description** - **description**
- Optional description of entity. - Optional description of entity.
- Type: `string` - Type: `string`
- **displayName**
- Display Name that identifies this entity.
- Type: `string`
- **href** - **href**
- Link to the entity resource. - Link to the entity resource.
- $ref: [basic.json#/definitions/href](basic.md#href) - $ref: [basic.json#/definitions/href](basic.md#href)
@ -35,4 +38,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -16,4 +16,4 @@ Type: `object`
- **Items** - **Items**
- $ref: [usageDetails.json](usagedetails.md) - $ref: [usageDetails.json](usagedetails.md)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -46,4 +46,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -17,4 +17,4 @@ Type: `object`
- Total number of entries available to page through. - Total number of entries available to page through.
- Type: `integer` - Type: `integer`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -41,4 +41,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -14,4 +14,4 @@ Type: `object`
- Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'. - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'.
- $ref: [basic.json#/definitions/duration](basic.md#duration) - $ref: [basic.json#/definitions/duration](basic.md#duration)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -32,4 +32,4 @@ This schema <u>does not</u> accept additional properties.
- Link to the tag resource. - Link to the tag resource.
- $ref: [basic.json#/definitions/href](basic.md#href) - $ref: [basic.json#/definitions/href](basic.md#href)
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_

View File

@ -39,4 +39,4 @@ Type: `object`
_This document was updated on: Tuesday, October 12, 2021_ _This document was updated on: Thursday, October 14, 2021_