Merge pull request #86 from open-metadata/docUpdate.part4

Doc update.part4
This commit is contained in:
Suresh Srinivas 2021-08-09 20:04:52 -07:00 committed by GitHub
commit a5cbf41ca3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 22 additions and 57 deletions

View File

@ -20,15 +20,15 @@
* [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)
* [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)
* [Team](openmetadata-apis/schemas/entities/teams/team.md)
* [Tag Category](openmetadata-apis/schemas/entities/tags/tagCategory.md)
* [User](openmetadata-apis/schemas/entities/teams/user.md)
* [APIs](openmetadata-apis/apis/README.md)
* [Overview](openmetadata-apis/apis/overview.md)

View File

@ -69,24 +69,24 @@ Metadata system has the following core entities:
## List of Schema Entities
{% page-ref page="bots.md" %}
{% page-ref page="dashboard.md" %}
{% page-ref page="data/dashboard.md" %}
{% page-ref page="database.md" %}
{% page-ref page="data/database.md" %}
{% page-ref page="databaseservice.md" %}
{% page-ref page="services/database-service.md" %}
{% page-ref page="thread.md" %}
{% page-ref page="feed/thread.md" %}
{% page-ref page="metrics.md" %}
{% page-ref page="data/metrics.md" %}
{% page-ref page="pipeline.md" %}
{% page-ref page="data/pipeline.md" %}
{% page-ref page="report.md" %}
{% page-ref page="data/report.md" %}
{% page-ref page="table.md" %}
{% page-ref page="data/table.md" %}
{% page-ref page="tagcategory.md" %}
{% page-ref page="tags/tag-category.md" %}
{% page-ref page="team.md" %}
{% page-ref page="teams/team.md" %}
{% page-ref page="user.md" %}
{% page-ref page="teams/user.md" %}

View File

@ -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="collection-descriptor.md" %}
{% page-ref page="dailyDount.md" %}
{% page-ref page="daily-count.md" %}
{% page-ref page="entityReference.md" %}
{% page-ref page="entity-reference.md" %}
{% page-ref page="entityUsage.md" %}
{% page-ref page="entity-usage.md" %}
{% page-ref page="jdbcConnection.md" %}
{% page-ref page="jdbc-connection.md" %}
{% page-ref page="profile.md" %}
{% page-ref page="schedule.md" %}
{% page-ref page="tagLabel.md" %}
{% page-ref page="tag-label.md" %}
{% page-ref page="usageDetails.md" %}
{% page-ref page="usage-details.md" %}

View File

@ -1,35 +0,0 @@
# Schema for collection descriptor
Type used for capturing the details of a collection.
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypecollectiondescriptor.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json</b>
Type: `object`
## Properties
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/properties/collection">collection</b>
- &#36;ref: [#/definitions/collectionInfo](#/definitions/collectionInfo)
## Definitions
**_collectionInfo_**
- Collection Info.
- Type: `object`
- **_Properties_**
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/name">name</b>
- Unique name that identifies a collection.
- Type: `string`
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/documentation">documentation</b>
- Description of collection.
- Type: `string`
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/href">href</b>
- URL of the API endpoint where given collections are available.
- Type: `string`
- String format must be a "uri"
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/images">images</b>
- &#36;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)_