yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-17 03:38:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [main] 69 pages modified

Browse Source
This commit is contained in:
Suresh Srinivas 2021-08-15 01:39:19 +00:00 committed by gitbook-bot
parent eede60b180
commit e6445a179c
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
7 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/SUMMARY.md
View File

@ -34,6 +34,7 @@
* [User](openmetadata-apis/schemas/entities/user.md)
* [APIs](openmetadata-apis/apis/README.md)
* [Overview](openmetadata-apis/apis/overview.md)
* [API Organization](openmetadata-apis/apis/api-organization.md)
* [Implementation notes](openmetadata-apis/apis/implementation-notes.md)
## Install

BIN
docs/openmetadata-apis/apis/README.md
View File

Binary file not shown.

23
docs/openmetadata-apis/apis/api-organization.md Normal file
View File

@ -0,0 +1,23 @@
# API Organization
OpenMetadata has the following APIs. See this [sandbox link](https://sandbox.open-metadata.org/docs) for full documentation related to APIs.
* Data Asset APIs - These API endpoints support operations related to data asset entities.
* `.../api/v1/databases`
* `...api/v1/tables`
* `.../api/v1/metrics`
* `.../api/v1/dashboards`
* `.../api/v1/reports`
* `.../api/v1/pipelines`
* Service APIs - These API endpoints support operations related to services from which metadata is collected:
* `.../api/v1/services` is the collection of all service resources.
* `.../api/v1/services/databaseService` is a resource used for APIs related to database services. This includes transactional databases - MySQL, Postgres, MSSQL, Oracle, and data warehouses - Apache Hive BigQuery, Redshift, and Snowflake.
* Teams & Users
* `.../api/v1/teams` for APIs related to team entities
* `.../api/v1/users` for APIs related to user entities
* Other APIs
* `.../api/v1/tags` for APIs related to Tag Category and Tag entities
* `../api/v1/feeds` for APIs related to Threads and Posts entities
* `.../api/v1/usage` for reporting usage information of entities
* `.../api/v1/search` for APIs related to entity search

2
docs/openmetadata-apis/apis/overview.md
View File

@ -4,8 +4,6 @@ description: This page provides the overview of API design
# Overview
OpenMetadata API is the best way to get metadata in and out of the metadata platform. This section describes the best practices adopted for the API design.
## URI
Following REST API conventions are followed for Resource URIs:

6
docs/openmetadata-apis/schemas/README.md
View File

@ -4,11 +4,7 @@
OpenMetadata takes the **schema-first** approach to model metadata as a Single Source of Truth with clear vocabulary for the system. First, the Entities, Types, and relationships between the entities in the system are identified and schemas are defined for them. Code is then generated from these schemas for implementation.
## Schemas
{% page-ref page="entities/" %}
{% page-ref page="types/" %}

2
docs/openmetadata-apis/schemas/entities/README.md
View File

@ -2,7 +2,7 @@
OpenMetadata has the following high level core entities and relationships:
OpenMetadata has the following high-level core entities and relationships:
![](../../../.gitbook/assets/openmetadata-entities-relationship.png)

4
docs/take-it-for-a-spin.md
View File

@ -2,9 +2,7 @@
We want our users to get the experience OpenMetadata with the least effort 😁. That is why we have set up a [sandbox](https://sandbox.open-metadata.org) that mimics a real production setup. We appreciate it if you take it for a spin and let us know your feedback on our [mailing list](mailto:openmetadata-user@googlegroups.com), or join our [slack channel](https://join.slack.com/t/openmetadata/shared_invite/zt-udl8ris3-Egq~YtJU_yJgJTtROo00dQ) and post a message in the [user](https://openmetadata.slack.com/archives/C02B38JFDDK) channel.
Here are few things to try out when you are on Sandbox...
Here is what to expect when are on Sandbox...
Here is what to expect when you are on Sandbox...
### Login using your Google credentials