diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b5e5e285292..585c6cf42df 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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 diff --git a/docs/openmetadata-apis/apis/README.md b/docs/openmetadata-apis/apis/README.md index 657515c7e69..bc5c1127ccd 100644 Binary files a/docs/openmetadata-apis/apis/README.md and b/docs/openmetadata-apis/apis/README.md differ diff --git a/docs/openmetadata-apis/apis/api-organization.md b/docs/openmetadata-apis/apis/api-organization.md new file mode 100644 index 00000000000..8f6dd5a77b0 --- /dev/null +++ b/docs/openmetadata-apis/apis/api-organization.md @@ -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 + diff --git a/docs/openmetadata-apis/apis/overview.md b/docs/openmetadata-apis/apis/overview.md index 9aef469cec7..73069532208 100644 --- a/docs/openmetadata-apis/apis/overview.md +++ b/docs/openmetadata-apis/apis/overview.md @@ -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: diff --git a/docs/openmetadata-apis/schemas/README.md b/docs/openmetadata-apis/schemas/README.md index e53622a52ed..265f663e4f1 100644 --- a/docs/openmetadata-apis/schemas/README.md +++ b/docs/openmetadata-apis/schemas/README.md @@ -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/" %} + diff --git a/docs/openmetadata-apis/schemas/entities/README.md b/docs/openmetadata-apis/schemas/entities/README.md index d366f91104f..9d4ec5a1633 100644 --- a/docs/openmetadata-apis/schemas/entities/README.md +++ b/docs/openmetadata-apis/schemas/entities/README.md @@ -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) diff --git a/docs/take-it-for-a-spin.md b/docs/take-it-for-a-spin.md index b018f936901..563c7137547 100644 --- a/docs/take-it-for-a-spin.md +++ b/docs/take-it-for-a-spin.md @@ -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