parthp2107 13be70e416
updated documentation (#508)
* updated documentation

* addressing pyline findings

* addressing pyline findings

* doc update

Co-authored-by: parthp2107 <parth@getcollate.io>
2021-09-18 20:13:31 -07:00

37 lines
1.4 KiB
Markdown

# Report
This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and visual form.
**$id: https://open-metadata.org/schema/entity/data/report.json**
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies this report.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this report instance uniquely.
- Type: `string`
- Length: between 1 and 64
- **fullyQualifiedName**
- A unique name that identifies a report in the format 'ServiceName.ReportName'.
- Type: `string`
- Length: between 1 and 64
- **description**
- Description of this report instance.
- Type: `string`
- **href**
- Link to the resource corresponding to this report.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this pipeline.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **service** `required`
- Link to service where this report is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Thursday, September 16, 2021_