yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-06 08:37:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/docs/openmetadata-apis/apis/api-organization.md
parthp2107 e2578d6be3
Added documentation changes done in 0.5.0 branch to main (#1168) 
* GitBook: [#177] Documentation Update - Airflow

* GitBook: [#195] Removing Cron from databaseServices

* GitBook: [#196] Added trino

* GitBook: [#197] removed cron from config

* GitBook: [#198] Added Redash Documentation

* GitBook: [#199] Added Bigquery Usage Documentation

* GitBook: [#200] Added page link for presto

* GitBook: [#201] Added Local Docker documentation

* GitBook: [#202] Added Documentation for Local Docker Setup

* GitBook: [#203] Added Git Command to clone Openmetadata in docs

* GitBook: [#207] links update

* GitBook: [#208] Updating Airflow Documentation

* GitBook: [#210] Adding Python installation package under Airflow Lineage config

* GitBook: [#211] Change the links to 0.5..0

* GitBook: [#213] Move buried connectors page up

* GitBook: [#214] Update to connectors page

* GitBook: [#215] Removed sub-categories

* GitBook: [#212] Adding Discovery tutorial

* GitBook: [#220] Updated steps to H2s.

* GitBook: [#230] Complex queries

* GitBook: [#231] Add lineage to feature overview

* GitBook: [#232] Make feature overview headers verbs instead of nouns

* GitBook: [#233] Add data reliability to features overview

* GitBook: [#234] Add complex data types to feature overview

* GitBook: [#235] Simplify and further distinguish discovery feature headers

* GitBook: [#236] Add data importance to feature overview

* GitBook: [#237] Break Connectors into its own section

* GitBook: [#238] Reorganize first section of docs.

* GitBook: [#239] Add connectors to feature overview

* GitBook: [#240] Organize layout of feature overview into feature categories as agreed with Harsha.

* GitBook: [#242] Make overview paragraph more descriptive.

* GitBook: [#243] Create a link to Connectors section from feature overview.

* GitBook: [#244] Add "discover data through association" to feature overview.

* GitBook: [#245] Update importance and owners gifs

* GitBook: [#246] Include a little more descriptive documentation for key features.

* GitBook: [#248] Small tweaks to intro paragraph.

* GitBook: [#249] Clean up data profiler paragraph.

* GitBook: [#250] Promote Complex Data Types to its own feature.

* GitBook: [#251] Update to advanced search

* GitBook: [#252] Update Roadmap

* GitBook: [#254] Remove old features page (text and screenshot based).

* GitBook: [#255] Remove references to removed page.

* GitBook: [#256] Add Descriptions and Tags section to feature overview.

* GitBook: [#257] Update title for "Know Your Data"

Co-authored-by: Ayush Shah <ayush.shah@deuexsolutions.com>
Co-authored-by: Suresh Srinivas <suresh@getcollate.io>
Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com>
Co-authored-by: OpenMetadata <github@harsha.io>
2021-11-13 09:33:20 -08:00

1.7 KiB
Raw Permalink Blame History

API Organization

OpenMetadata has the following APIs. See this sandbox link 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
    • .../api/v1/topics
  • 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 - APIs related to database services. This includes transactional databases - MySQL, Postgres, MSSQL, Oracle, and data warehouses - Apache Hive BigQuery, Redshift, and Snowflake.
    • .../api/v1/services/dashboardService - APIs related to dashboard services. This includes Looker, Superset, and Tableau.
    • .../api/v1/services/messaingService - APIs related to messaging services. This includes Apache Kafka and Apache Pulsar (work in progress).
  • Teams & Users APIs
    • .../api/v1/teams - APIs related to team entities
    • .../api/v1/users - APIs related to user entities
  • Search & Suggest APIs - These API endpoints support search and suggest APIs:
    • .../api/v1/search - collection for search and suggest APIs
    • .../api/v1/search/query - search entities using query text
    • .../api/v1/search/suggest - get suggested entities used for auto-completion
  • 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