Fixes docs that reference messaging service instead of dashboard or pipeline (#613) (#614)

This commit is contained in:
Julia Valenti 2021-09-29 19:21:31 -04:00 committed by GitHub
parent bfec0bfbed
commit a514934f16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 13 deletions

View File

@ -2,7 +2,7 @@
"$id": "https://open-metadata.org/schema/entity/services/dashboardService.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Dashboard Service",
"description": "This schema defines the Messaging Service entity, such as Kafka and Pulsar.",
"description": "This schema defines the Dashboard Service entity, such as Looker and Superset.",
"type": "object",
"definitions": {
"dashboardServiceType": {
@ -67,7 +67,7 @@
"$ref": "../../type/schedule.json"
},
"href": {
"description": "Link to the resource corresponding to this messaging service.",
"description": "Link to the resource corresponding to this dashboard service.",
"$ref": "../../type/basic.json#/definitions/href"
}
},

View File

@ -38,7 +38,7 @@
"$ref": "#/definitions/pipelineServiceType"
},
"description": {
"description": "Description of a messaging service instance.",
"description": "Description of a pipeline service instance.",
"type": "string"
},
"pipelineUrl": {
@ -51,7 +51,7 @@
"$ref": "../../type/schedule.json"
},
"href": {
"description": "Link to the resource corresponding to this messaging service.",
"description": "Link to the resource corresponding to this pipeline service.",
"$ref": "../../type/basic.json#/definitions/href"
}
},

View File

@ -17,7 +17,7 @@
*/
/**
* This schema defines the Messaging Service entity, such as Kafka and Pulsar.
* This schema defines the Dashboard Service entity, such as Looker and Superset.
*/
export interface DashboardService {
/**
@ -29,7 +29,7 @@ export interface DashboardService {
*/
description?: string;
/**
* Link to the resource corresponding to this messaging service.
* Link to the resource corresponding to this dashboard service.
*/
href?: string;
/**

View File

@ -21,11 +21,11 @@
*/
export interface PipelineService {
/**
* Description of a messaging service instance.
* Description of a pipeline service instance.
*/
description?: string;
/**
* Link to the resource corresponding to this messaging service.
* Link to the resource corresponding to this pipeline service.
*/
href?: string;
/**

View File

@ -1,6 +1,6 @@
# Dashboard Service
This schema defines the Messaging Service entity, such as Kafka and Pulsar.
This schema defines the Dashboard Service entity, such as Looker and Superset.
**$id: https://open-metadata.org/schema/entity/services/dashboardService.json**
@ -34,7 +34,7 @@ Type: `object`
- Schedule for running metadata ingestion jobs.
- $ref: [../../type/schedule.json](../types/schedule.md)
- **href**
- Link to the resource corresponding to this messaging service.
- Link to the resource corresponding to this dashboard service.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)

View File

@ -47,5 +47,5 @@ class DashboardService(BaseModel):
)
href: Optional[basic.Href] = Field(
None,
description='Link to the resource corresponding to this messaging service.',
description='Link to the resource corresponding to this dashboard service.',
)

View File

@ -28,7 +28,7 @@ class PipelineService(BaseModel):
None, description='Type of pipeline service such as Airflow or Prefect...'
)
description: Optional[str] = Field(
None, description='Description of a messaging service instance.'
None, description='Description of a pipeline service instance.'
)
pipelineUrl: AnyUrl = Field(..., description='Pipeline Service Management/UI URL')
ingestionSchedule: Optional[schedule.Schedule] = Field(
@ -36,5 +36,5 @@ class PipelineService(BaseModel):
)
href: Optional[basic.Href] = Field(
None,
description='Link to the resource corresponding to this messaging service.',
description='Link to the resource corresponding to this pipeline service.',
)